Get an assigned participant
get
/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments/{SrpCompPlanId}
Request
Path Parameters
-
CompensationPlanId(required): integer(int64)
The unique identifier of the compensation plan.
-
SrpCompPlanId(required): integer(int64)
The unique identifier of the compensation plan.
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 : compensationPlans-CompensationPlanAssignments-item-response
Type:
Show Source
object
-
AcceptanceStatus: string
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. -
AnalystId: integer
(int64)
Title:
Analyst
Read Only:true
The unique identifier of the analyst assigned to a participant. -
AnalystName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the analyst assigned to a participant. -
AssignmentType: string
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. -
CompensationPlanId: integer
(int64)
Title:
Compensation Plan
The unique identifier of the base compensation plan. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the compensation plan assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the compensation plan assignment was created. -
EndDate: string
(date)
Title:
End Date
The date when the compensation plan assignment becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the compensation plan assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the compensation plan assignment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantId: integer
(int64)
Title:
Participant Name
The unique identifier of the participant. -
ParticipantName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the participant. -
ParticipantPlanNumber: string
Title:
Participant Plan Number
Maximum Length:30
The alternate key identifier of the participant plan. -
ParticipantType: string
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. -
PersonNumber: string
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. -
RoleId: integer
(int64)
Title:
Name
Read Only:true
The unique identifier of a incentive compensation role. -
RoleName: string
Title:
Name
Read Only:true
Maximum Length:60
The name of the incentive compensation role. -
SrpCompPlanId: integer
(int64)
The unique identifier of the compensation plan.
-
StartDate: string
(date)
Title:
Start Date
The date when the compensation plan assignment becomes active. -
ViewPlanDocument: string
(byte)
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.
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
- CnLookupAcceptanceStatus
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_SRP_APPR_STATUS
The list of values indicating the status of the published compensation plan document.
The following properties are defined on the LOV link relation:- Source Attribute: AcceptanceStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CnLookupAssignmentType
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PARTICIPANT_PLN_ASSIGN_TYPE
The list of values indicating whether the compensation plan is assigned directly or through a role.
The following properties are defined on the LOV link relation:- Source Attribute: AssignmentType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CnLookupParticipantType
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PARTICIPANT_TYPE
The list of values indicating the type of participant, such as an administrator or a sales team member.
The following properties are defined on the LOV link relation:- Source Attribute: ParticipantType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: