Gets a single rule qualifying criteria detail.
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleQualifyingCriteria/{incentiveCompensationRuleQualifyingCriteriaUniqID}
Request
Path Parameters
-
incentiveCompensationRuleQualifyingCriteriaUniqID(required): string
This is the hash key of the attributes which make up the composite key--- RuleId and RuleAttrValueId ---for the Incentive Compensation Rule Qualifying Criteria resource and used to uniquely identify an instance of Incentive Compensation Rule Qualifying Criteria. The client should not generate the hash key value. Instead, the client should query on the Incentive Compensation Rule Qualifying Criteria collection resource with a filter on the primary key values in order to navigate to a specific instance of Incentive Compensation Rule Qualifying Criteria.
For example: incentiveCompensationRuleQualifyingCriteria?q=RuleId=<value1>;RuleAttrValueId=<value2>
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: 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.
There's no request body for this operation.
Back to TopResponse
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 : incentiveCompensationRuleQualifyingCriteria-item-response
Type:
Show Source
object-
AttributeDescription: string
Read Only:
trueMaximum Length:1000The description of the rule attribute. -
AttributeId: integer
(int64)
Read Only:
trueThe identifier of the qualifier attribute. -
AttributeName: string
Read Only:
trueMaximum Length:160The name of the rule attribute. -
AttrUsageId: integer
(int64)
Read Only:
trueThe unique identifier of the rule attribute usage. -
AttrValueMeaning: string
Read Only:
trueMaximum Length:4000The meaning of the rule attribute value. -
ComparisonOperator: string
Read Only:
trueMaximum Length:30The comparison operator used in the rule attribute. -
ConvertToIdFlag: boolean
Read Only:
trueMaximum Length:1The convert to ID flag indicator for the rule attribute. -
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time the record was created. -
DisplayType: string
Read Only:
trueMaximum Length:30The display type of the rule attribute. -
EnabledFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the rule attribute is active. -
EndDate: string
(date)
Read Only:
trueThe end date of the rule. -
HighValueChar: string
Read Only:
trueMaximum Length:360The high value for character type rule attribute value. -
HighValueNumber: number
Read Only:
trueThe high value for number type rule attribute value. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Indicates the session login associated to the user who last updated the record. -
LevelFromParent: number
Read Only:
trueIndicates how far the rule is from the parent rule. -
LevelFromRoot: number
Read Only:
trueIndicates how far the rule is from the root node of the hierarchy. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LookupCode: string
Read Only:
trueMaximum Length:30The lookup code of the operator. -
LookupMeaning: string
Read Only:
trueMaximum Length:80The lookup meaning of the operator. -
LookupType: string
Read Only:
trueMaximum Length:30The lookup type of the comparison operator. -
LowValueChar: string
Read Only:
trueMaximum Length:360The low value for character type rule attribute value. -
LowValueCharCode: string
Read Only:
trueMaximum Length:360The low value code for character type rule attribute value. -
LowValueCharId: integer
(int64)
Read Only:
trueThe low value identifier for character type rule attribute value. -
LowValueNumber: number
Read Only:
trueThe low value for number type rule attribute value. -
NumberOfWinners: integer
(int32)
Read Only:
trueThe number of winners for the rule hierarchy. -
OrgId: integer
(int64)
Read Only:
trueThe unique identifier of the rule's business unit. -
Rank: integer
(int64)
Read Only:
trueThe rank of the rule. -
RuleAttributeId: integer
(int64)
Read Only:
trueThe identifier of the rule attribute. -
RuleAttrValueId: integer
(int64)
Read Only:
trueThe identifier of the rule attribute value. -
RuleDescription: string
Read Only:
trueMaximum Length:1000The description of the rule. -
RuleId: integer
Read Only:
trueThe unique identifier of the rule. -
RuleName: string
Read Only:
trueMaximum Length:160The name of the rule. -
RuleNumber: string
Read Only:
trueMaximum Length:30The number of the rule. -
StartDate: string
(date)
Read Only:
trueThe start date of the rule. -
UsageId: integer
(int64)
Read Only:
trueThe usage identifier of the rule attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.