Get all element entries
get
/hcmRestApi/resources/11.13.18.05/elementEntries
Request
Query Parameters
-
effectiveDate: string
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
-
expand: string
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).
-
fields: string
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 -
finder: string
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
- OfferId; integer; 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;
- PrimaryKey Finds all element entries based on the specified primary key criteria.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
Effective-Of:
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. -
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.
There's no request body for this operation.
Back to TopResponse
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 : elementEntries
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : elementEntries-item-response
Type:
Show Source
object
-
AssignmentId: integer
Unique identifier for a person assignment.
-
AssignmentNumber: string
Read Only:
true
Maximum Length:255
Person's assignment number for the element entry. -
CreatorType: string
Title:
Creator Type
Maximum Length:30
Name of the user or the process that created the element entry record, such as batch element entry. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the period within which the entry is available for processing with element entry identifier. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the period within which the entry is available for processing. -
ElementEntryHistory: array
Element Entry History
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. -
ElementEntryId: integer
(int64)
Unique identifier for an element entry.
-
elementEntryValues: array
Element Entry Values
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. -
ElementName: string
Maximum Length:
80
Name of the element the entry is for, such as Performance Bonus. -
ElementTypeId: integer
(int64)
Title:
Element Name
Unique identifier of the element type. -
EntrySequence: integer
(int64)
Title:
Sequence Number
Unique number that identifies an element entry record when overlapping entries exists for the same element. -
EntryType: string
Title:
Entry Type
Maximum Length:30
Type of the element entry, such as regular entry or override. -
Intent: string
Maximum Length:
200
Apply internal finder validation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelationshipNumber: string
Read Only:
true
Maximum Length:255
Unique number that identifies the association between a person and a payroll statutory unit based on the payroll calculation and reporting requirements. -
PersonId: integer
(int64)
Unique identifier for a person.
-
PersonNumber: string
Read Only:
true
Maximum Length:30
Person number of the worker. -
Reason: string
Title:
Reason
Maximum Length:4000
Reason for creating or updating an element entry. -
Subpriority: integer
(int32)
Title:
Subpriority
Number used to sequence the processing of element entries with the same priority. -
UsageLevel: string
Title:
Employment Level
Read Only:true
Maximum Length:30
Employment level of the element at which the entry is created.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : elementEntries-ElementEntryHistory-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Read Only:
true
Default entry value for the element entry. -
EffectiveStartDate: string
(date)
Read Only:
true
Unique identifier for an element entry value. -
ElementEntryId: integer
(int64)
Read Only:
true
Number assigned to an input value that determines the sequence in which the values appear. -
ElementTypeId: integer
(int64)
Read Only:
true
Indicates whether the existing entry values should be updated when the default value is updated. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates whether a value is required for the input. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Source location of the values contained within a list of values. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultipleEntryCount: integer
(int64)
Read Only:
true
Unique identifier for an input value. -
Reason: string
Read Only:
true
Maximum Length:4000
Name of the element's input value. -
Subpriority: integer
(int32)
Read Only:
true
Entry values contained within a list of values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : elementEntries-elementEntryValues-item-response
Type:
Show Source
object
-
BaseName: string
Title:
Name
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
DefaultValue: string
Read Only:
true
Maximum Length:60
Default entry value for the element entry. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
Number assigned to an input value that determines the sequence in which the values appear. -
ElementEntryValueId: integer
(int64)
Unique identifier for an element entry value.
-
HotDefaultFlag: boolean
Title:
Apply default at run time
Read Only:true
Maximum Length:30
Indicates whether the existing entry values should be updated when the default value is updated. -
InputValueId: integer
(int64)
Unique identifier for an input value.
-
InputValueName: string
Name of the element's input value.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LovScreenEntryValue: string
Maximum Length:
60
Entry values contained within a list of values. -
MandatoryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a value is required for the input. -
PAY_VALUE_SET_ValueSetScreenEntryValue_VALUE_SET_SWITCHER: string
Read Only:
true
-
ReservedInputValue: string
Title:
Special Purpose
Read Only:true
Maximum Length:30
Unique identifier for the payroll -
ScreenEntryDataURL: string
Read Only:
true
Maximum Length:255
Source location of the values contained within a list of values. -
ScreenEntryValue: string
Maximum Length:
60
Entry for input values available for each entry of the element. -
UOM: string
Read Only:
true
Maximum Length:30
Name of the type of measurement that's applicable to a number displayed in a balance, amount, or other type of numeric field such as money, character or number. -
UserEnterableFlag: boolean
Title:
Allow User Entry
Read Only:true
Maximum Length:1
Indicates whether the user can enter input values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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": [ { ...} ] }