Get all participants
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 -
finder: string
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 the participant with the specified primary key.
Finder Variables:- ParticipantId; integer; The unique identifier of a participant.
- SearchActiveParticipant: Finds a participant with the specified primary key.
Finder Variables:- bParticipantId; integer; The unique identifier for a participant.
- bParticipantName; string; The name of the participant.
- bPersonNumber; 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.
- bWorkerNumber; string; The employee number generated by Human Resources.
- PrimaryKey: Finds the participant with the specified primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- ActiveFlag; boolean; Indicates whether the participant is active or not. Possible values include FALSE for not active, and TRUE for active. The default value is TRUE.
- AnalystId; integer; The unique identifier of the analyst assigned to this participant.
- AnalystName; string; The name of the analyst assigned to the participant.
- CompensationEndDate; string; The date up to which the participant may be paid even if he is no longer an active participant. The application generates paysheets based on this date, which may extend out beyond the participant's end date.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date and time when the record was created.
- EmailAddress; string; The email address of the participant.
- EndDate; string; The date and time when the participant becomes inactive.
- HoldPaymentFlag; boolean; Indicates whether to stop paying the participant's payments when the payment batch is paid. The default value is false.
- HoldReason; string; Indicates why the payment is on hold. Possible values include DISPUTE for payment dispute, LEAVE for leave of absence, and TERMINATED when the participant is terminated. A list of acceptable values is defined in the lookup CN_HOLD_REASON_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The session login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- OrgId; integer; The unique identifier of the business unit.
- ParticipantDeleteFlag; boolean; Indicates whether the participant can be removed.
- ParticipantFirstName; string; The first name of the participant.
- ParticipantId; integer; The unique identifier for a participant.
- ParticipantLastName; string; The last name of the participant.
- ParticipantName; string; The name of the participant in incentive compensation.
- ParticipantType; string; Indicates whether the participant is an administrator (responsible for updating tools) or a sales team member (capable of getting sales credit.) Possible values include ANALYST for Administrator, and PARTICIPANT for 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.
- PartyId; integer; The unique identifier for the party record in the Trading Community Model.
- PartyNumber; string; The user-defined value of the party associated with the participant. A party can be a partner, a salesperson, a vendor, a resource, or an employee. In the case of an employee from HR, the party number might hold the employee number (not ID). In the case of a customer, the party number might hold the customer number (not ID).
- PartyOriginalSystem; string; The name of the participant party record in the Trading Community Model.
- PartyOriginalSystemId; string; The unique identifier for the participant party record in the Trading Community Model.
- PayeeOnlyFlag; boolean; Indicates if the participant is assigned as a payee to another participant's plan, and does not have his own plan. The default value is true.
- 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.
- StartDate; string; The date and time when the participant becomes active.
- WorkerNumber; string; The Employee number assigned by Human Resources.
-
totalResults: boolean
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : incentiveCompensationParticipants
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationParticipants-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the participant is active or not. Possible values include FALSE for not active, and TRUE for active. The default value is TRUE. -
AnalystId: integer
(int64)
Title:
Analyst Identifier
The unique identifier of the analyst assigned to this participant. -
AnalystName: string
Title:
Analyst
Maximum Length:360
The name of the analyst assigned to the participant. -
CompensationEndDate: string
(date)
Title:
Compensation End Date
The date up to which the participant may be paid even if he is no longer an active participant. The application generates paysheets based on this date, which may extend out beyond the participant's end date. -
CostCenter: string
Title:
Cost Center
The participant's cost center as of the effective date range of the detail record. The cost center will be default in the participant detail record, when the value is passed in the participant header post operation. -
CountryCode: string
Title:
Country
The code representing the country where the participant works, as of the effective date range of the detail record. The country code will be default in the participant detail record, when the value is passed in the participant header post operation. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurrencyCode: string
Title:
Home Currency
The code representing the participant's home currency, as of the effective date range of the detail record. The home currency will be default in the participant detail record, when the value is passed in the participant header post operation. -
EmailAddress: string
Title:
Email Address
Read Only:true
Maximum Length:320
The email address of the participant. -
EndDate: string
(date)
Title:
Active End Date
The date and time when the participant becomes inactive. -
HoldPaymentFlag: boolean
Title:
Hold payment
Maximum Length:1
Default Value:false
Indicates whether to stop paying the participant's payments when the payment batch is paid. The default value is false. -
HoldReason: string
Title:
Hold Reason
Maximum Length:30
Indicates why the payment is on hold. Possible values include DISPUTE for payment dispute, LEAVE for leave of absence, and TERMINATED when the participant is terminated. A list of acceptable values is defined in the lookup CN_HOLD_REASON_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
ParticipantDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether the participant can be removed. -
ParticipantDetails: array
Participant Details
Title:
Participant Details
The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc. -
ParticipantFirstName: string
Title:
Participant First Name
Maximum Length:150
The first name of the participant. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier for a participant. -
ParticipantLastName: string
Title:
Participant Last Name
Maximum Length:150
The last name of the participant. -
ParticipantName: string
Title:
Participant Name
Maximum Length:360
The name of the participant in incentive compensation. -
ParticipantRoles: array
Participant Roles
Title:
Participant Roles
The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager. -
participantsDFF: array
Participants Descriptive Flex Fields
Title:
Participants Descriptive Flex Fields
The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field. -
ParticipantType: string
Title:
Type
Maximum Length:60
Indicates whether the participant is an administrator (responsible for updating tools) or a sales team member (capable of getting sales credit.) Possible values include ANALYST for Administrator, and PARTICIPANT for 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. -
PartyId: integer
(int64)
Title:
Party Identifier
The unique identifier for the party record in the Trading Community Model. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The user-defined value of the party associated with the participant. A party can be a partner, a salesperson, a vendor, a resource, or an employee. In the case of an employee from HR, the party number might hold the employee number (not ID). In the case of a customer, the party number might hold the customer number (not ID). -
PartyOriginalSystem: string
Title:
Party Original System
Maximum Length:60
The name of the participant party record in the Trading Community Model. -
PartyOriginalSystemId: string
Title:
Party Original System ID
Maximum Length:60
The unique identifier for the participant party record in the Trading Community Model. -
PayeeOnlyFlag: boolean
Title:
Payee Only
Maximum Length:1
Indicates if the participant is assigned as a payee to another participant's plan, and does not have his own plan. The default value is true. -
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. -
StartDate: string
(date)
Title:
Active Start Date
The date and time when the participant becomes active. -
WorkerNumber: string
Title:
Worker Number
Maximum Length:30
The Employee number assigned by Human Resources.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Participant Details
Type:
array
Title:
Participant Details
The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.
Show Source
Nested Schema : Participant Roles
Type:
array
Title:
Participant Roles
The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.
Show Source
Nested Schema : Participants Descriptive Flex Fields
Type:
array
Title:
Participants Descriptive Flex Fields
The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field.
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.
Nested Schema : incentiveCompensationParticipants-ParticipantDetails-item-response
Type:
Show Source
object
-
CostCenter: string
Title:
Cost Center
Maximum Length:30
The participant's cost center as of the effective date range of the detail record. -
CountryCode: string
Title:
Country
Maximum Length:30
The code representing the country where the participant works, as of the effective date range of the detail record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurrencyCode: string
Title:
Home Currency
Maximum Length:30
The code representing the participant's home currency, as of the effective date range of the detail record. -
EndDate: string
(date)
Title:
Effective End Date
The date and time when the detail stops applying for the participant. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantDetailDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether the participant details can be deleted. -
ParticipantDetailId: integer
(int64)
The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.
-
participantDetailsDFF: array
Participant Details Descriptive Flex Fields
Title:
Participant Details Descriptive Flex Fields
The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field. -
ParticipantId: integer
(int64)
The unique identifier for a participant.
-
StartDate: string
(date)
Title:
Effective Start Date
The date and time when the detail record starts applying for the participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Participant Details Descriptive Flex Fields
Type:
array
Title:
Participant Details Descriptive Flex Fields
The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.
Show Source
Nested Schema : incentiveCompensationParticipants-ParticipantDetails-participantDetailsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
The flex context segment code for the participant details. It determines which context-sensitive segments are displayed. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The flex context segment display name for the participant details. It determines which context-sensitive segments are displayed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantDetailId: integer
(int64)
The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationParticipants-ParticipantRoles-item-response
Type:
Show Source
object
-
AccessType: string
Title:
Access Type
Read Only:true
Maximum Length:30
Default Value:INDIVIDUAL
The lookup code that represents the access type, such as manager or individual. Possible values include INDIVIDUAL which specifies that the participant access is individual, and MANAGER which specifies that the participant access is manager. The default value is INDIVIDUAL. A list of acceptable values is defined in the lookup CN_ACCESS_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDateActive: string
(date)
Title:
Role End Date
The date when the role assignment ends for that participant. The format is yyyy-mm-dd. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login 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 Identifier
The unique identifier of the participant record. -
ParticipantRoleId: integer
(int64)
Title:
Participant Role ID
The unique identifier for the participant role. -
PreserveRoleAssignmentFlag: boolean
Title:
Preserve Assignment
Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update. -
RoleId: integer
(int64)
Title:
Role ID
The unique identifier for a role assigned to a participant record. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
StartDateActive: string
(date)
Title:
Role Start Date
The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : incentiveCompensationParticipants-participantsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
The flex context segment code for the participant. It determines which context-sensitive segments are displayed. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The flex context segment display name for the participant. It determines which context-sensitive segments are displayed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantId: integer
(int64)
Title:
Participant Identifier
The unique identifier for a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all participants 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/incentiveCompensationParticipants
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "ParticipantId": 999666333000583, "ActiveFlag": true, "AnalystId": 999666333001005, "CompensationEndDate": null, "CreatedBy": "OIC_MGR_OPERATIONS", "CreationDate": "2009-08-21T10:08:55-07:00", "EndDate": null, "HoldPaymentFlag": false, "HoldReason": null, "PersonNumber": "10024202226", "WorkerNumber": null, "LastUpdateDate": "2017-05-03T07:27:08-07:00", "LastUpdateLogin": "OIC_MGR_OPERATIONS", "LastUpdatedBy": "OIC_MGR_OPERATIONS", "OrgId": 204, "ParticipantFirstName": "Zachary ", "ParticipantLastName": " Carter", "ParticipantName": "Zachary Carter", "ParticipantType": "PARTICIPANT", "PartyId": 100010025531958, "PartyNumber": "100010025531958", "PayeeOnlyFlag": null, "PartyOriginalSystem": "FUSION_HCM", "PartyOriginalSystemId": "100010024202226", "StartDate": "1995-01-01", "AnalystName": "Aaron Holmes", "ParticipantDeleteFlag": false, "EmailAddress": "sendmail-test-discard@oracle.com", "links": [ ... ] }, { "ParticipantId": 999666333000584, "ActiveFlag": true, "AnalystId": 999666333001005, "CompensationEndDate": null, "CreatedBy": "10000", "CreationDate": "2009-08-21T10:08:55-07:00", "EndDate": null, "HoldPaymentFlag": false, "HoldReason": null, "PersonNumber": "10024202738", "WorkerNumber": null, "LastUpdateDate": "2009-12-11T13:13:57-08:00", "LastUpdateLogin": "7A77AC6C7404D426E04044987CF02D4A", "LastUpdatedBy": "OPERATIONS", "OrgId": 204, "ParticipantFirstName": "Conor", "ParticipantLastName": "Barker", "ParticipantName": "Barker,Conor", "ParticipantType": "PARTICIPANT", "PartyId": 100010025531952, "PartyNumber": "100010025531952", "PayeeOnlyFlag": null, "PartyOriginalSystem": "FUSION_HCM", "PartyOriginalSystemId": "100010024202738", "StartDate": "1995-01-01", "AnalystName": "Aaron Holmes", "ParticipantDeleteFlag": false, "EmailAddress": null, "links": [ ... ] } , ... ] }