Jump to

• Request
• Response

Update one qualifier

patch

/fscmRestApi/resources/11.13.18.05/channelProgramTypes/{ProgramTypeId}/child/qualifiers/{QualifierId}

Request

Path Parameters

• ProgramTypeId(required): integer(int64)
  Value that uniquely identifies the channel program type. It's a primary key that the application generates when it creates the program type.
• QualifierId(required): integer(int64)
  Value that uniquely identifies the channel program type qualifier. It's a primary key that the application generates when it creates the qualifier.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DefaultQualifierFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the date qualifier will be set to the default while creating a channel program. If false, then the date qualifier will not be set to the default while creating a channel program. This attribute doesn't not have a default value.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the channel program type.
• QualifierId: integer (int64)
  Value that uniquely identifies the channel program type qualifier. It's a primary key that the application generates when it creates the qualifier.
• QualifierType: string
  Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.

{
    "type":"object",
    "properties":{
        "DefaultQualifierFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the date qualifier will be set to the default while creating a channel program. If false, then the date qualifier will not be set to the default while creating a channel program. This attribute doesn't not have a default value.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program type qualifier. It's a primary key that the application generates when it creates the qualifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.",
            "nullable":true
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.",
            "nullable":false
        }
    }
}

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 : channelProgramTypes-qualifiers-item-response

Type: object

Show Source

• 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.
• DateQualifierFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the qualifier is a date qualifier. If false, then the qualifier is not a date qualifier. The default value for this attribute is false.
• DefaultQualifierFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the date qualifier will be set to the default while creating a channel program. If false, then the date qualifier will not be set to the default while creating a channel program. This attribute doesn't not have a default value.
• 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.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the channel program type.
• QualifierId: integer (int64)
  Value that uniquely identifies the channel program type qualifier. It's a primary key that the application generates when it creates the qualifier.
• QualifierType: string
  Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DateQualifierFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the qualifier is a date qualifier. If false, then the qualifier is not a date qualifier. The default value for this attribute is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultQualifierFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the date qualifier will be set to the default while creating a channel program. If false, then the date qualifier will not be set to the default while creating a channel program. This attribute doesn't not have a default value.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program type qualifier. It's a primary key that the application generates when it creates the qualifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE. Qualifier types added in program type can only be selected in channel program market rule, market rule conditions, and program rule.",
            "nullable":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":false
        }
    }
}

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