Get a participant for a role
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}
Request
Path Parameters
-
ParticipantRoleId(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=
-
RoleId(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 : incentiveCompensationRoles-RoleParticipants-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Maximum Length:1
-
AnalystName: string
Title:
Analyst
Read Only:true
Maximum Length:360
-
CompensationEndDate: string
(date)
Title:
Compensation End Date
Read Only:true
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
-
EndDateActive: string
(date)
Title:
Assignment End Date
-
HoldPaymentFlag: boolean
Title:
Hold payment
Read Only:true
Maximum Length:1
-
HRPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
-
HRPrimaryWorkerNumber: string
Title:
Worker Number
Read Only:true
Maximum Length:30
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
-
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Title:
Business Unit
Read Only:true
-
ParticipantId: integer
(int64)
Title:
Participant Name
-
ParticipantName: string
Title:
Participant Name
Read Only:true
Maximum Length:360
-
ParticipantRoleId: integer
(int64)
-
ParticipantType: string
Title:
Type
Read Only:true
Maximum Length:60
-
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
-
PayeeOnly: string
Title:
Payee Only
Read Only:true
Maximum Length:1
-
PreserveRoleAssignmentFlag: boolean
Title:
Preserve Assignment
-
RoleId: integer
(int64)
Title:
Name
-
StartDateActive: string
(date)
Title:
Assignment Start Date
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
- BusinessUnitPVO
-
The business units list of values resource is used to view the list of defined business units.
- CnLookupParticipantTypeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PARTICIPANT_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:
- ParticipantsVO
-
Parameters:
- finder:
SearchActiveParticipant
The participants resource is used to view and update a participant. A participant is anyone in the system who could receive a credit or is an associate in the sales hierarchy, e.g.: a Sales Manager or a Sales Representative. - finder:
Examples
The following example shows how to get details of a specific role participant by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ParticipantRoleId": 300100089785737, "StartDateActive": "2015-01-01", "ParticipantId": 2001, "RoleId": 300100089785736, "LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA", "LastUpdatedBy": "OIC_MGR_OPERATIONS", "LastUpdateDate": "2017-03-16T19:10:10+05:30", "CreationDate": "2017-03-16T17:16:44+05:30", "CreatedBy": "OIC_MGR_OPERATIONS", "EndDateActive": "2016-12-31", "ActiveFlag": true, "HRPrimaryWorkerNumber": null, "ParticipantType": "PARTICIPANT", "PartyNumber": "300100005347180", "CompensationEndDate": null, "HoldPaymentFlag": false, "OrgId": 204, "HRPersonNumber": null, "PayeeOnly": "N", "ParticipantName": "IC_PARTY_VO_20111202135553", "AnalystName": null, "PreserveRoleAssignmentFlag": "true", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737", "name": "RoleParticipants", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737", "name": "RoleParticipants", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736", "name": "roles", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/BusinessUnitPVO", "name": "BusinessUnitPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/ParticipantsVO", "name": "ParticipantsVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/CnLookupParticipantTypeVO", "name": "CnLookupParticipantTypeVO", "kind": "collection" } ] }