Jump to

• Request
• Response

Update one market rule

patch

/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/marketRules/{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)
  Value that uniquely identifies the market rule. It is a primary key that the application generates when it creates the market rule.

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

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• conditions: array Conditions
  Title: Conditions

  The Conditions resource manages additional conditions for a market rule of a program.
• FromDate: string (date)
  Date when the qualifier becomes applicable.
• QualifierType: string
  Maximum Length: 255

  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.
• QualifierTypeCode: string
  Maximum Length: 30

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

  Abbreviation that identifies the qualifier used in channel program qualification.
• ToDate: string (date)
  Date when the qualifier is no longer applicable.

{
    "type":"object",
    "properties":{
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the qualifier becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the qualifier is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "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"
            }
        },
        "QualifierType":{
            "maxLength":"255",
            "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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "conditions":{
            "title":"Conditions",
            "type":"array",
            "description":"The Conditions resource manages additional conditions for a market rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-patch-request"
            }
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Conditions

Type: array

Title: Conditions

The Conditions resource manages additional conditions for a market rule of a program.

Show Source

• Array of: object channelPrograms-marketRules-conditions-item-patch-request

{
    "title":"Conditions",
    "type":"array",
    "description":"The Conditions resource manages additional conditions for a market rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-patch-request"
    }
}

Nested Schema : channelPrograms-marketRules-conditions-item-patch-request

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• 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.
• QualifierTypeCode: string
  Maximum Length: 30

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

  Abbreviation that identifies the qualifier used in channel program qualification.

{
    "type":"object",
    "properties":{
        "QualifierValueCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "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.",
            "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"
            }
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "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-marketRules-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• conditions: array Conditions
  Title: Conditions

  The Conditions resource manages additional conditions for a market rule of a program.
• 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.
• FromDate: string (date)
  Date when the qualifier becomes applicable.
• 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.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program.
• QualifierId: integer (int64)
  Value that uniquely identifies the market rule. It is a primary key that the application generates when it creates the market rule.
• QualifierType: string
  Maximum Length: 255

  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.
• QualifierTypeCode: string
  Maximum Length: 30

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

  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.
• ToDate: string (date)
  Date when the qualifier is no longer applicable.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated 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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule. It is a primary key that the application generates when it creates the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "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
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":"255",
            "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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the qualifier becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the qualifier is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "conditions":{
            "title":"Conditions",
            "type":"array",
            "description":"The Conditions resource manages additional conditions for a market rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Conditions

Type: array

Title: Conditions

The Conditions resource manages additional conditions for a market rule of a program.

Show Source

• Array of: object channelPrograms-marketRules-conditions-item-response

{
    "title":"Conditions",
    "type":"array",
    "description":"The Conditions resource manages additional conditions for a market rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-response"
    }
}

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 : channelPrograms-marketRules-conditions-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule condition. 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.
• 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.
• QualifierConditionId: integer (int64)
  Value that uniquely identifies the market rule condition. It is a primary key that the application generates when it creates the market rule condition.
• QualifierId: integer (int64)
  Value that uniquely identifies the market rule.
• 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.
• QualifierTypeCode: string
  Maximum Length: 30

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

  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in channel program qualification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated 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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of qualifier used in channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "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"
            },
            "x-queryable":true
        },
        "QualifierConditionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule condition. It is a primary key that the application generates when it creates the market rule condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "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
        },
        "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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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."
        }
    }
}

Links

conditions

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/marketRules/{QualifierId}/child/conditions

Parameters:

• ProgramId: $request.path.ProgramId
• QualifierId: $request.path.QualifierId

The Conditions resource manages additional conditions for a market rule of a program.

Back to Top