Update a descriptive flex field
/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF/{ParticipantDetailId2}
Request
-
ParticipantDetailId(required): integer(int64)
The unique identifier for the participant's detail record. A participant can have multiple details records without overlapping date ranges.
-
ParticipantDetailId2(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=
-
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.
-
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.
- application/json
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
- application/json
Default Response
-
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.
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.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_PARTICIPANT_DETAIL_DFF
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_PARTICIPANT_DETAIL_DFF
The list of values containing the flex context segment codes for the participant details. It determines which context-sensitive segments are displayed.
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
The following example shows how to update a descriptive flex field by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/999666333000023/child/ParticipantDetails/999666333000023/child/participantDetailsDFF/999666333000023
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "ParticipantDetailsDff2": 100 }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ParticipantDetailId": 999666333000023, "ParticipantDetailsDff1": null, "ParticipantDetailsDff2": 100, "ParticipantDetailsDff3": null, "ParticipantDetailsDff4Date": null, "__FLEX_Context": null, "__FLEX_Context_DisplayValue": null, "links": [ ... ] }