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

Create an element entry

post

/hcmRestApi/resources/11.13.18.05/elementEntries

Request

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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Element Entry History
Type: array
Title: Element Entry History
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
Show Source
Nested Schema : Element Entry Values
Type: array
Title: Element Entry Values
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
Show Source
Nested Schema : elementEntries-ElementEntryHistory-item-post-request
Type: object
Show Source
Nested 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-item-response
Type: object
Show Source
Nested Schema : Element Entry History
Type: array
Title: Element Entry History
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
Show Source
Nested Schema : Element Entry Values
Type: array
Title: Element Entry Values
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
Show Source
Nested Schema : elementEntries-ElementEntryHistory-item-response
Type: object
Show Source
Nested Schema : elementEntries-elementEntryValues-item-response
Type: object
Show Source
Links
ElementEntryHistory
Parameters:
  • elementEntriesUniqID: $request.path.elementEntriesUniqID
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
creatorTypesLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DPAY_CREATOR_TYPE%2CLookupCode%3D{CreatorType}
The following properties are defined on the LOV link relation:
  • Source Attribute: CreatorType; Target Attribute: LookupCode
  • Display Attribute: Meaning
elementEntryValues
Parameters:
  • elementEntriesUniqID: $request.path.elementEntriesUniqID
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
Back to Top

Examples

The following example shows how to create an element entry by submitting a POST request on the REST resource using cURL.

curl -u <user>:<password> -H "Content-Type:application/json" -X POST -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/elementEntries

Example of Payload

The following is an example of the payload.

{
   "PersonId": 300100003143709,
   "ElementTypeId": 300100003068055,
   "AssignmentId": 300100003143747,
   "EntryType": "E",
   "CreatorType": "F",
   "EntrySequence": 1,
   "elementEntryValues": [
   {
     "InputValueId": 300100003068067,
     "ScreenEntryValue": "1000"
   }
 ]
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type : application/json

Example of Response Body

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

{
    "ElementEntryId": 300100559371979,
    "EffectiveStartDate": "2020-07-25",
    "EffectiveEndDate": "4712-12-31",
    "CreatorType": "F",
    "ElementTypeId": 300100003068055,
    "EntryType": "E",
    "EntrySequence": 1,
    "PersonId": 300100003143709,
    "Reason": null,
    "Subpriority": null,
    "PersonNumber": "300100003143709",
    "AssignmentId": 300100003143747,
    "AssignmentNumber": "E300100003143709",
    "PayrollRelationshipNumber": "300100003143743",
    "ElementName": "ZHRX_USP_RegEarnings_One",
    "UsageLevel": "PA",
    "elementEntryValues": {
        "items": []
    "links": [
        {
          ...}
    ]
}
Back to Top