Get a rule
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}
Request
Path Parameters
-
RuleId(required): integer(int64)
The unique identifier of a rule. This values is generated during a create action.
-
RuleId2(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 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 : incentiveCompensationRuleHierarchies-Rules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the rule hierarchy. -
CreationDate: string
(date-time)
Read Only:
true
The date when the hierarchy was created. -
Description: string
Title:
Description
Maximum Length:1000
The description of the rule. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the rule is enabled. -
EndDate: string
(date)
Title:
End Date
The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the hierarchy was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the hierarchy. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:160
The name of the rule. -
NumberOfWinners: integer
(int32)
Title:
Number of Winners
Default Value:1
The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types. -
OrganizationId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
ParentRuleId: integer
(int64)
Title:
Parent
The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule. -
ParentRuleName: string
Title:
Name
Read Only:true
Maximum Length:160
The name of the parent rule. -
ParentRuleNumber: string
Title:
Rule Number
Read Only:true
Maximum Length:30
The unique identifier of the parent rule. -
Rank: integer
(int64)
Title:
Rank
The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types. -
RuleId: integer
(int64)
Read Only:
true
The unique identifier of a rule. This values is generated during a create action. -
RuleNumber: string
Title:
Rule Number
Maximum Length:30
The unique identifier for the rule. This value can be system-generated or user-provided during a create action. -
RuleTypeId: integer
(int64)
Title:
Rule Type
The unique identifier of the rule type. -
StartDate: string
(date)
Title:
Start Date
The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- BusinessUnitLovViewAccessor
-
The business units list of values resource is used to view the list of defined business units.
- EnabledFlagLovViewAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_YES_NO
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder:
- ParentRuleViewAccessor
-
The rule hierarchies resource is used for direct crediting, classification, rollup crediting, team crediting, participant role assignment, and analyst approvals. Rule hierarchies are set of rules arranged in hierarchical fashion, where a child rule inherits the criterion of the parent rule. Rule hierarchies are created and managed for each rule type such as crediting, classification, or rollup.
- RuleTypeLovViewAccessor
-
Parameters:
- finder:
BuIdFinder
The rule types list of values resource is used to view the list of rule types. It indicates the specific usage of the rule such as classification, crediting and other usages. - finder: