Create a rule assignment
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments
Request
Path Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignedObjectId: integer
(int64)
Title:
Name
The unique identifier of the assigned object. -
AssignedObjectType: string
Title:
Type
Maximum Length:30
The type of assignment, such as participant, role, team, group, or eligible category. -
EndDate: string
(date)
Title:
End Date
The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types. -
GroupMemberCreditFlag: boolean
Title:
Receive direct credit
Maximum Length:1
Default Value:false
Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types. -
OrganizationId: integer
(int64)
The unique identifier of the business unit.
-
RevenueType: string
Title:
Revenue Type
Maximum Length:30
Default Value:REVENUE
The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
RoleId: integer
(int64)
Title:
Role
The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant. -
RollupFlag: boolean
Title:
Roll Up to Parents
Maximum Length:1
Default Value:false
Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type. -
RuleId: integer
(int64)
Title:
Parent
The unique identifier of the rule. -
SplitPercent: number
Title:
Split Percent
Default Value:100
The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type. -
StartDate: string
(date)
Title:
Start Date
The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types. -
SummaryFlag: boolean
Title:
Summarize rollups
Maximum Length:1
Default Value:false
Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.
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-RuleAssignments-item-response
Type:
Show Source
object
-
AssignedObjectId: integer
(int64)
Title:
Name
The unique identifier of the assigned object. -
AssignedObjectName: string
Read Only:
true
The name of the assigned object. -
AssignedObjectType: string
Title:
Type
Maximum Length:30
The type of assignment, such as participant, role, team, group, or eligible category. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the rule assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the rule assignment was created. -
EndDate: string
(date)
Title:
End Date
The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types. -
GroupMemberCreditFlag: boolean
Title:
Receive direct credit
Maximum Length:1
Default Value:false
Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the rule assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the rule assignment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the rule assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
The unique identifier of the business unit.
-
RevenueType: string
Title:
Revenue Type
Maximum Length:30
Default Value:REVENUE
The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
RoleId: integer
(int64)
Title:
Role
The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant. -
RoleName: string
Title:
Name
Read Only:true
Maximum Length:60
The name of the role associated with the participant assigned to the rule. -
RollupFlag: boolean
Title:
Roll Up to Parents
Maximum Length:1
Default Value:false
Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type. -
RuleAssignmentId: integer
(int64)
Read Only:
true
The unique identifier of rule assignment. This value is generated during a create action. -
RuleId: integer
(int64)
Title:
Parent
The unique identifier of the rule. -
SplitPercent: number
Title:
Split Percent
Default Value:100
The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type. -
StartDate: string
(date)
Title:
Start Date
The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types. -
SummaryFlag: boolean
Title:
Summarize rollups
Maximum Length:1
Default Value:false
Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.
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
- AssignedObjectTypeAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_RS_ASSIGNED_OBJECT_TYPE%2CLookupCode%3DELIGIBLE_CATEGORY
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:
- GroupMemberCreditFlagLookupViewAccessor
-
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:
- ParticipantsLovViewAccessor
-
The credit categories resource is used to view, create, update, and delete a credit category and its details. Credit categories provide the eligibility of a participant, a team, or a manager to receive credit for a transaction.
- RollupFlagLookupViewAccessor
-
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:
- RollupRevenueTypeAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_RS_REVENUE_TYPE
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:
- SummaryFlagLookupViewAccessor
-
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: