Jump to

• Request
• Response

Update one program rule

patch

/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/programRules/{QualifierId}

Request

Path Parameters

• ProgramId(required): integer(int64)
  Value that uniquely identifies the channel program. It is a primary key that the application generates when it creates the program.
• QualifierId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• QualifierType: string
  Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define channel program eligibility.
• QualifierValue: string
  Maximum Length: 255

  Name of the qualifier used in channel program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in channel program qualification.

{
    "type":"object",
    "properties":{
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define channel program eligibility.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : channelPrograms-programRules-item-response

Type: object

Show Source

• AccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the bill-to customer account.
• Address: string
  Read Only: true

  Maximum Length: 255

  Address for the customer. It applies if the qualifier type is Customer, Bill-to Account, or Ship To.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Customer: string
  Read Only: true

  Maximum Length: 255

  Name of the customer.
• CustomQualifierFlag: boolean
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, it's a custom qualifier; if false, it isn't. The default value is false.
• DomainDataTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of dimension data. Valid values include text, number, date, and timestamp. Accepted values are defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.
• DomainLookupTypeCode: string
  Read Only: true

  Maximum Length: 255

  Lookup type code for the dimension within the lookup domain type.
• DomainTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of domain. Valid values include lookup, view object query, and custom. Accepted values are defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login that the user used when updating the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixDimensionId: integer
  Read Only: true

  Value that uniquely identifies the dimension.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program.
• QualifierId: integer (int64)
  Value that uniquely identifies the program rule.
• QualifierNumberValueCode: integer
  Read Only: true

  Value of the numeric qualifier used in the supplier program qualification.
• QualifierType: string
  Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define channel program eligibility.
• QualifierValue: string
  Maximum Length: 255

  Name of the qualifier used in channel program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in channel program qualification.
• Site: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site or the ship-to site.

{
    "type":"object",
    "properties":{
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address for the customer. It applies if the qualifier type is Customer, Bill-to Account, or Ship To.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CustomQualifierFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, it's a custom qualifier; if false, it isn't. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DomainDataTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of dimension data. Valid values include text, number, date, and timestamp. Accepted values are defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DomainLookupTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup type code for the dimension within the lookup domain type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DomainTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of domain. Valid values include lookup, view object query, and custom. Accepted values are defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Login that the user used when updating the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in the supplier program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define channel program eligibility.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Site":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ComparisonOperatorVVO

Parameters:

• finder: LookupTypeFinder%3BbindLookupType%3DORA_CJM_QUALIFIER_OPERATOR

The following properties are defined on the LOV link relation:

• Source Attribute: ComparisonOperatorCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top