1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Incentive Compensation Rule Hierarchies
  4. Rule Assignments

Get all rule assignments

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a rule assignment with the specified identifier.
      Finder Variables:
      • RuleAssignmentId; integer; The unique identifier of a rule assignment.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignedObjectId; integer; The unique identifier of the assigned object.
    • AssignedObjectName; string; The name of the assigned object.
    • AssignedObjectType; string; The type of assignment, such as participant, role, team, group, or eligible category.
    • CreatedBy; string; The user who created the rule assignment.
    • CreationDate; string; The date when the rule assignment was created.
    • EndDate; string; 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; 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; The date when the rule assignment was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the rule assignment.
    • LastUpdatedBy; string; The user who last updated the rule assignment.
    • OrganizationId; integer; The unique identifier of the business unit.
    • RevenueType; string; 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; The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.
    • RoleName; string; The name of the role associated with the participant assigned to the rule.
    • RollupFlag; boolean; Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.
    • RuleAssignmentId; integer; The unique identifier of rule assignment. This value is generated during a create action.
    • RuleId; integer; The unique identifier of the rule.
    • SplitPercent; number; The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.
    • StartDate; string; 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; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : incentiveCompensationRuleHierarchies-RuleAssignments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationRuleHierarchies-RuleAssignments-item-response
Type: object
Show Source
  • Title: Name
    The unique identifier of the assigned object.
  • Read Only: true
    The name of the assigned object.
  • Title: Type
    Maximum Length: 30
    The type of assignment, such as participant, role, team, group, or eligible category.
  • Read Only: true
    Maximum Length: 64
    The user who created the rule assignment.
  • Read Only: true
    The date when the rule assignment was created.
  • 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.
  • 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.
  • Read Only: true
    The date when the rule assignment was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the rule assignment.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the rule assignment.
  • Links
  • The unique identifier of the business unit.
  • 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.
  • Title: Role
    The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.
  • Title: Name
    Read Only: true
    Maximum Length: 60
    The name of the role associated with the participant assigned to the rule.
  • 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.
  • Read Only: true
    The unique identifier of rule assignment. This value is generated during a create action.
  • Title: Parent
    The unique identifier of the rule.
  • 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.
  • 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.
  • 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.
Back to Top