1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Participants
  4. Participant Details

Get all participant details

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Participants resource and used to uniquely identify an instance of Participants. The client should not generate the hash key value. Instead, the client should query on the Participants collection resource in order to navigate to a specific instance of Participants to get the hash key.
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 participant detail with the specified primary key.
      Finder Variables:
      • ParticipantDetailId; integer; The unique identifier of a participant detail. A participant can have multiple details records without overlapping date ranges.
  • 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:
    • CostCenter; string; The participant's cost center as of the effective date range of the detail record.
    • CountryCode; string; The code representing the country where the participant works, as of the effective date range of the detail record.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • CurrencyCode; string; The code representing the participant's home currency, as of the effective date range of the detail record.
    • EndDate; string; The date and time when the detail stops applying for the participant.
    • 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.
    • ParticipantDetailDeleteFlag; boolean; Indicates whether the participant details can be deleted.
    • ParticipantDetailId; integer; The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.
    • ParticipantId; integer; The unique identifier for a participant.
    • StartDate; string; The date and time when the detail record starts applying for the participant.
  • 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 : incentiveCompensationParticipants-ParticipantDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationParticipants-ParticipantDetails-item-response
Type: object
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: object
Show Source
  • Title: Context Value
    Maximum Length: 30
    The flex context segment code for the participant details. It determines which context-sensitive segments are displayed.
  • Title: Context Value
    The flex context segment display name for the participant details. It determines which context-sensitive segments are displayed.
  • Links
  • The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.
Back to Top

Examples

The following example shows how to get all participant details 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/999666333000023/child/ParticipantDetails

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "ParticipantDetailId": 999666333000023,
      "CostCenter": null,
      "CountryCode": "US",
      "CreatedBy": "OIC_MGR_OPERATIONS",
      "CreationDate": "2009-08-17T17:25:32-07:00",
      "CurrencyCode": "USD",
      "EndDate": "2012-12-31",
      "LastUpdateDate": "2009-08-17T17:25:32-07:00",
      "LastUpdateLogin": "4FA525997C5C6DC5E0532DD6F00A3E7B",
      "LastUpdatedBy": "OIC_MGR_OPERATIONS",
      "ParticipantId": 999666333000023,
      "StartDate": "1995-01-01",
      "ParticipantDetailDeleteFlag": false,
      "links": [
       ...
      ]
    },
    {
      "ParticipantDetailId": 300100089854601,
      "CostCenter": "New",
      "CountryCode": "US",
      "CreatedBy": "OIC_MGR_OPERATIONS",
      "CreationDate": "2017-05-16T07:21:35-07:00",
      "CurrencyCode": "USD",
      "EndDate": "2015-12-31",
      "LastUpdateDate": "2017-05-16T07:21:35.375-07:00",
      "LastUpdateLogin": "4FA525997C5C6DC5E0532DD6F00A3E7B",
      "LastUpdatedBy": "OIC_MGR_OPERATIONS",
      "ParticipantId": 999666333000023,
      "StartDate": "2015-01-01",
      "ParticipantDetailDeleteFlag": false,
      "links": [
       ...
      ]
    }
  ,
 ...
  ]
}
Back to Top