1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Compensation Plans
  4. Assigned Participants

Get all assigned participants

get

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments

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:

    • PlanDirectAssignmentsFinder: Finds a direct assignment with the specified primary key.
      Finder Variables:
      • PlanRoleAssignmentsFinder: Finds a role assignment with the specified primary key.
        Finder Variables:
        • PrimaryKey: Finds an assignment with the specified primary key.
          Finder Variables:
          • SrpCompPlanId; integer; The unique identifier of the compensation plan.
      • 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:
        • AcceptanceStatus; string; The status of the published participant compensation plan document. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status can be updated when the Enable Plan Approval and Acceptance Workflow attribute are set to the No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.
        • AnalystId; integer; The unique identifier of the analyst assigned to a participant.
        • AnalystName; string; The name of the analyst assigned to a participant.
        • AssignmentType; string; The type of the assignment, for example whether a participant is assigned to a compensation plan directly or through a role. A list of acceptable values is defined in the lookup CN_PARTICIPANT_PLN_ASSIGN_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
        • CompensationPlanId; integer; The unique identifier of the base compensation plan.
        • CreatedBy; string; The user who created the compensation plan assignment.
        • CreationDate; string; The date and time when the compensation plan assignment was created.
        • EndDate; string; The date when the compensation plan assignment becomes inactive.
        • LastUpdateDate; string; The date and time when the compensation plan assignment was last updated.
        • LastUpdateLogin; string; The login details of the user who last updated the record.
        • LastUpdatedBy; string; The user who last updated the compensation plan assignment.
        • ParticipantId; integer; The unique identifier of the participant.
        • ParticipantName; string; The name of the participant.
        • ParticipantPlanNumber; string; The alternate key identifier of the participant plan.
        • ParticipantType; string; The type of the participant. This attribute indicates whether the participant is an administrator, responsible for updating tools, or a sales team member, capable of getting a sales credit. Possible values include ANALYST for an Administrator, and PARTICIPANT for a Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
        • PersonNumber; string; The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.
        • RoleId; integer; The unique identifier of a incentive compensation role.
        • RoleName; string; The name of the incentive compensation role.
        • SrpCompPlanId; integer; The unique identifier of the compensation plan.
        • StartDate; string; The date when the compensation plan assignment becomes active.
      • 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 : compensationPlans-CompensationPlanAssignments
      Type: object
      Show Source
      Nested Schema : Items
      Type: array
      Title: Items
      The items in the collection.
      Show Source
      Nested Schema : compensationPlans-CompensationPlanAssignments-item-response
      Type: object
      Show Source
      • Title: Acceptance Status
        Maximum Length: 30
        Default Value: ACCEPTED
        The status of the published participant compensation plan document. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status can be updated when the Enable Plan Approval and Acceptance Workflow attribute are set to the No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.
      • Title: Analyst
        Read Only: true
        The unique identifier of the analyst assigned to a participant.
      • Title: Name
        Read Only: true
        Maximum Length: 360
        The name of the analyst assigned to a participant.
      • Title: Assignment Type
        Maximum Length: 30
        The type of the assignment, for example whether a participant is assigned to a compensation plan directly or through a role. A list of acceptable values is defined in the lookup CN_PARTICIPANT_PLN_ASSIGN_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
      • Title: Compensation Plan
        The unique identifier of the base compensation plan.
      • Read Only: true
        Maximum Length: 64
        The user who created the compensation plan assignment.
      • Read Only: true
        The date and time when the compensation plan assignment was created.
      • Title: End Date
        The date when the compensation plan assignment becomes inactive.
      • Read Only: true
        The date and time when the compensation plan assignment was last updated.
      • Read Only: true
        Maximum Length: 64
        The user who last updated the compensation plan assignment.
      • Read Only: true
        Maximum Length: 32
        The login details of the user who last updated the record.
      • Links
      • Title: Participant Name
        The unique identifier of the participant.
      • Title: Name
        Read Only: true
        Maximum Length: 360
        The name of the participant.
      • Title: Participant Plan Number
        Maximum Length: 30
        The alternate key identifier of the participant plan.
      • Title: Type
        Read Only: true
        Maximum Length: 60
        Default Value: PARTICIPANT
        The type of the participant. This attribute indicates whether the participant is an administrator, responsible for updating tools, or a sales team member, capable of getting a sales credit. Possible values include ANALYST for an Administrator, and PARTICIPANT for a Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
      • Title: Person Number
        Read Only: true
        Maximum Length: 30
        The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.
      • Title: Name
        Read Only: true
        The unique identifier of a incentive compensation role.
      • Title: Name
        Read Only: true
        Maximum Length: 60
        The name of the incentive compensation role.
      • The unique identifier of the compensation plan.
      • Title: Start Date
        The date when the compensation plan assignment becomes active.
      • Read Only: true
        The link to the plan document. The plan document contains details about the compensation plan assigned to the participant. It is only available if the plan approval feature has been enabled using the Setup and Maintenance, Manage Parameters task. The plan document gets generated once the participant's plan is submitted for approval.
      Back to Top