Jump to

• Request
• Response

Get one additional condition

get

/fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/additionalConditions/{QualifierId}

Request

Path Parameters

• ProgramId(required): integer(int64)
  Value that uniquely identifies the customer program.
• QualifierId(required): integer(int64)
  Value that uniquely identifies the additional condition.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• 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.

There's no request body for this operation.

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 : channelCustomerPrograms-additionalConditions-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

  Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the additional condition. 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 the additional condition.
• 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

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

  Maximum Length: 255

  Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is 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 of the lookup domain type.
• DomainTypeCode: string
  Read Only: true

  Maximum Length: 255

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

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated 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 customer program.
• QualifierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the additional condition.
• QualifierNumberValueCode: integer
  Read Only: true

  Value of the numeric qualifier used in customer program qualification.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define customer program eligibility.
• QualifierValue: string
  Read Only: true

  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in customer 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":{
        "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":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperator":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the comparison operator used in the additional condition.  A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address":{
            "maxLength":"255",
            "type":"string",
            "description":"Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualifier used in customer program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the additional condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in customer program qualification.",
            "nullable":false,
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in customer program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainDataTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the additional condition.",
            "nullable":false,
            "x-queryable":false
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define customer program eligibility.",
            "nullable":false,
            "x-queryable":true
        },
        "DomainLookupTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Lookup type code for the dimension of the lookup domain type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomQualifierFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top