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

Get all element entries

get

/hcmRestApi/resources/11.13.18.05/elementEntries

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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 all element entries based on the specified primary key criteria.
      Finder Variables
      • EffectiveEndDate; string; Effective end date of the element entry.
      • EffectiveStartDate; string; Effective start date of the element entry.
      • ElementEntryId; integer; Unique identifier for an element entry.
    • findByAssignmentNumber Finds all element entries based on the specified assignment criteria.
      Finder Variables
      • AssignmentNumber; string; Unique identifier for a person assignment.
      • SysEffectiveDate; object;
    • findByElementEntryId Finds all element entries based on the specified element entry criteria.
      Finder Variables
      • ElementEntryId; integer; Unique identifier for an element entry.
      • SysEffectiveDate; object;
    • findByIntent Finds all the element entries based on the specified intent criteria.
      Finder Variables
      • ElementEntryId; integer; Apply internal finder validation with supported list of intents. Supported list of intents
      • Intent; string; Apply internal finder validation with supported list of intents. Supported list of intents
      • ReloadTransactionId; integer; Apply internal finder validation with supported list of intents. Supported list of intents
      • SysEffectiveDate; object;
  • 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:
    • AssignmentNumber; string; Person's assignment number for the element entry.
    • CreatorType; string; Name of the user or the process that created the element entry record, such as batch element entry.
    • EffectiveEndDate; string; Date at the end of the period within which the entry is available for processing with element entry identifier.
    • EffectiveStartDate; string; Date at the beginning of the period within which the entry is available for processing.
    • ElementEntryId; integer; Unique identifier for an element entry.
    • ElementName; string; Name of the element the entry is for, such as Performance Bonus.
    • ElementTypeId; integer; Unique identifier of the element type.
    • EntrySequence; integer; Unique number that identifies an element entry record when overlapping entries exists for the same element.
    • EntryType; string; Type of the element entry, such as regular entry or override.
    • PayrollRelationshipNumber; string; Unique number that identifies the association between a person and a payroll statutory unit based on the payroll calculation and reporting requirements.
    • PersonId; integer; Unique identifier for a person.
    • PersonNumber; string; Person number of the worker.
    • Reason; string; Reason for creating or updating an element entry.
    • Subpriority; integer; Number used to sequence the processing of element entries with the same priority.
    • UsageLevel; string; Employment level of the element at which the entry is created.
  • 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
  • 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.

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 : elementEntries
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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
Back to Top

Examples

The following example shows how to retrieve all the element entries for a person by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type:application/json" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/elementEntries/?q=PersonNumber='300100003143709'

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK 
Content-Type : application/json

Example of Response Body

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

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