1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Element Entries
  4. Element Entry Values

Update an element entry value

patch

/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues/{elementEntryValuesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- ElementEntryId, EffectiveStartDate and EffectiveEndDate ---for the Element Entries resource and used to uniquely identify an instance of Element Entries. The client should not generate the hash key value. Instead, the client should query on the Element Entries collection resource with a filter on the primary key values in order to navigate to a specific instance of Element Entries.

    For example: elementEntries?q=ElementEntryId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>
  • This is the hash key of the attributes which make up the composite key for the Element Entry Values resource and used to uniquely identify an instance of Element Entry Values. The client should not generate the hash key value. Instead, the client should query on the Element Entry Values collection resource in order to navigate to a specific instance of Element Entry Values to get the hash key.
Header Parameters
  • 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.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : elementEntries-elementEntryValues-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update an element entry value by submitting a PATCH request on the REST resource using cURL. In this example, the element entry has been corrected by specifying the range mode and the range start date.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of: RangeMode=CORRECTION;RangeStartDate=2020-07-25" -X PATCH -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/elementEntries/00020000000EACED00057708000110F09B3DA3500000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001798712640078/child/elementEntryValues/00020000000EACED00057708000110F09B3DA3520000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001798712640078

Example of Payload

The following is an example of the payload.

{
  "ScreenEntryValue": 5000
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  ScreenEntryValue: "5000"
  ElementEntryValueId: 300100559414098
  InputValueId: 300100003068067
  InputValueName: "Amount"
  "links": [
        {
          ...}
    ]
}
Back to Top