Create a participant detail
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails
Request
Path Parameters
-
incentiveCompensationParticipantsUniqID(required): string
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
CurrencyCode(required): 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. -
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(required): integer
(int64)
The unique identifier for a participant.
-
StartDate(required): string
(date)
Title:
Effective Start Date
The date and time when the detail record starts applying for the participant.
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 : schema
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. -
ParticipantDetailId: integer
(int64)
The unique identifier for the participant's detail record. A participant can have multiple detail records without overlapping date ranges.
Response
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-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 : 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-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
Links
- CountryCodeVO
-
The list of values containing the codes indicating the country where the participant works, as of the effective date range of the detail record.
The following properties are defined on the LOV link relation:- Source Attribute: CountryCode; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- CurrencyCodeVO
-
The list of values containing the codes indicating the participant home currency, as of the effective date range of the detail record.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode, Name
- participantDetailsDFF
-
Parameters:
- ParticipantDetailId:
$request.path.ParticipantDetailId
- incentiveCompensationParticipantsUniqID:
$request.path.incentiveCompensationParticipantsUniqID
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. - ParticipantDetailId:
Examples
The following example shows how to create a participant detail by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/999666333000023/child/ParticipantDetails
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "CostCenter": "New", "CountryCode": "US", "CurrencyCode": "USD", "EndDate": "2015-12-31", "StartDate": "2015-01-01", }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "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": [ ... ] }