Update a qualifying criterion
patch
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}
Request
Path Parameters
-
RuleAttributeId(required): integer(int64)
The unique identifier of the rule attribute. This value is generated during a create action.
-
RuleId(required): integer(int64)
The unique identifier of a rule. This values is generated during a create action.
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
Root Schema : schema
Type:
Show Source
object
-
OrganizationId: integer
(int64)
The unique identifier of the business unit.
-
QualifyingAttributeValues: array
Qualifying Attribute Values
Title:
Qualifying Attribute Values
The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule. -
RuleId: integer
(int64)
The unique identifier of the rule.
Nested Schema : Qualifying Attribute Values
Type:
array
Title:
Qualifying Attribute Values
The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ComparisonOperator: string
Title:
Operator
Maximum Length:30
Default Value:EQUAL_TO
The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
HighValueCharacter: string
Title:
Character High Value
Maximum Length:360
The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between. -
HighValueNumber: integer
Title:
High Value Number
The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between. -
LowValueCharacter: string
Title:
Character Low Value
Maximum Length:360
The low value of a character attribute. This value is applicable if the qualifying criteria is a free text. -
LowValueCharacterCode: string
Maximum Length:
360
The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type. -
LowValueCharacterId: integer
(int64)
The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.
-
LowValueNumber: integer
Title:
Low Value Number
The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between. -
OrganizationId: integer
(int64)
The unique identifier of the business unit.
-
RuleAttributeId: integer
(int64)
The unique identifier of the rule attribute.
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.
Root Schema : incentiveCompensationRuleHierarchies-QualifyingCriteria-item-response
Type:
Show Source
object
-
AttributeUsageId: integer
(int64)
Title:
Attribute Usage Identifier
The unique identifier of the rule attribute usage. This value specifies the applicability of the qualifier for a rule type. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the qualifying criterion. -
CreationDate: string
(date-time)
Read Only:
true
The date when the qualifying criterion was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the qualifying criterion. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the qualifying criterion was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the qualifying criterion. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the qualifying criterion. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Attribute Name
Read Only:true
Maximum Length:160
The name of the qualifying criterion. -
OrganizationId: integer
(int64)
The unique identifier of the business unit.
-
QualifyingAttributeValues: array
Qualifying Attribute Values
Title:
Qualifying Attribute Values
The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule. -
RuleAttributeId: integer
(int64)
Read Only:
true
The unique identifier of the rule attribute. This value is generated during a create action. -
RuleId: integer
(int64)
The unique identifier of the rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Qualifying Attribute Values
Type:
array
Title:
Qualifying Attribute Values
The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response
Type:
Show Source
object
-
ComparisonOperator: string
Title:
Operator
Maximum Length:30
Default Value:EQUAL_TO
The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the qualifying attribute value. -
CreationDate: string
(date-time)
Read Only:
true
The date when the qualifying attribute value was created. -
HighValueCharacter: string
Title:
Character High Value
Maximum Length:360
The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between. -
HighValueNumber: integer
Title:
High Value Number
The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the qualifying attribute value was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the qualifying attribute value. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the qualifying attribute value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LowValueCharacter: string
Title:
Character Low Value
Maximum Length:360
The low value of a character attribute. This value is applicable if the qualifying criteria is a free text. -
LowValueCharacterCode: string
Maximum Length:
360
The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type. -
LowValueCharacterId: integer
(int64)
The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.
-
LowValueNumber: integer
Title:
Low Value Number
The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between. -
OrganizationId: integer
(int64)
The unique identifier of the business unit.
-
RuleAttributeId: integer
(int64)
The unique identifier of the rule attribute.
-
RuleAttributeValueId: integer
(int64)
Read Only:
true
The unique identifier of the rule attribute value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- QualifyingAttributeValues
-
Parameters:
- RuleAttributeId:
$request.path.RuleAttributeId
- RuleId:
$request.path.RuleId
The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule. - RuleAttributeId:
- RuleAttributeUsagesLovViewAccessor
-
Parameters:
- finder:
BuIdFinder
The rule attributes list of values resource is used to view the list of the qualifiers, their operators, and the rule types the qualifiers are used in. - finder: