Get all time records
get
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords
Request
Path Parameters
-
timeRecordGroupId(required): integer
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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 a time record using its unique identifier.
Finder Variables- timeRecordId; number; Unique identifier of the time record.
- filterByGroupType Finds time records using a specific time record layer.
Finder Variables- groupType; string; Layer where time records are retrieved from, such as processed time or absence entry details.
- filterByPerIdTimeGrp Finds time records using the person identifier and the start and end times.
Finder Variables- groupType; string; Layer where time records are retrieved from, such as processed time or absence entry details.
- personId; integer; Unique identifier for the person associated with the time record.
- startTime; string; Start time for the range containing the time record groups to retrieve.
- stopTime; string; End time for the range containing the time record groups to retrieve.
- filterByPerNumTimeGrp Finds time records using the person number and the start and end times.
Finder Variables- groupType; string; Layer where time records are retrieved from, such as processed time or absence entry details.
- personNumber; string; Number for the person associated with the time record.
- startTime; string; Start time for the range containing the time records to retrieve.
- stopTime; string; End time for the range containing the time records to retrieve.
- filterByTmRecGrpId Finds time records for a defined time record group identifier.
Finder Variables- timeRecordGroupId; integer; Unique identifier for the time record group.
- filterByTmRecId Finds a time record using its time record identifier.
Finder Variables- timeRecordId; number; Unique identifier for the time record.
- PrimaryKey Finds a time record using its unique identifier.
-
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; Assignment number for the person associated with the time record.
- comment; string; Comment associated with the time record.
- earnedDate; string; Time entry date determined by the earned day rule configuration.
- groupType; string; Layer where time record groups are retrieved from, such as processed time or posted schedule shift.
- measure; number; Quantity, in hours or units, for the time record.
- overtimeDate; string; Time entry date determined by the overtime day rule and start time configuration.
- personId; integer; Unique identifier for the person associated with the time record.
- personNumber; string; Number for the person associated with the time record.
- recordType; string; Type for the time record, either measure or range.
- startDate; string; Start date for the range containing the time records to retrieve.
- startTime; string; Start time for the range containing the time records to retrieve.
- stopDate; string; End date for the range containing the time records to retrieve.
- stopTime; string; End time for the range containing the time records to retrieve.
- timeRecordGroupId; integer; Unique identifier for the time record group containing the reported time record.
- timeRecordGroupVersion; integer; Version number for the time record group stored in the Workforce Management time repository.
- timeRecordId; number; Unique identifier for the time record.
- timeRecordVersion; integer; Version number for the time record stored in the Workforce Management time repository.
- unitOfMeasure; string; Unit of measure for the time record, such as hours or units.
-
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
-
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 : timeRecordGroups-timeRecords
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 : timeRecordGroups-timeRecords-item-response
Type:
Show Source
object
-
assignmentNumber: string
Read Only:
true
Maximum Length:50
Assignment number for the person associated with the time record. -
comment: string
Read Only:
true
Maximum Length:1000
Comment associated with the time record. -
earnedDate: string
(date)
Read Only:
true
Time entry date determined by the earned day rule configuration. -
groupType: string
Read Only:
true
Maximum Length:255
Layer where time record groups are retrieved from, such as processed time or posted schedule shift. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measure: number
Read Only:
true
Quantity, in hours or units, for the time record. -
overtimeDate: string
(date)
Read Only:
true
Time entry date determined by the overtime day rule and start time configuration. -
personId: integer
(int64)
Read Only:
true
Unique identifier for the person associated with the time record. -
personNumber: string
Read Only:
true
Maximum Length:30
Number for the person associated with the time record. -
recordType: string
Read Only:
true
Maximum Length:30
Type for the time record, either measure or range. -
startDate: string
(date)
Read Only:
true
Start date for the range containing the time records to retrieve. -
startTime: string
(date-time)
Read Only:
true
Start time for the range containing the time records to retrieve. -
stopDate: string
(date)
Read Only:
true
End date for the range containing the time records to retrieve. -
stopTime: string
(date-time)
Read Only:
true
End time for the range containing the time records to retrieve. -
timeAttributes: array
Time Attributes
Title:
Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group. -
timeMessages: array
Time Messages
Title:
Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations. -
timeRecordGroupId: integer
(int64)
Read Only:
true
Unique identifier for the time record group containing the reported time record. -
timeRecordGroupVersion: integer
(int32)
Read Only:
true
Version number for the time record group stored in the Workforce Management time repository. -
timeRecordId: number
Read Only:
true
Unique identifier for the time record. -
timeRecordVersion: integer
(int32)
Read Only:
true
Version number for the time record stored in the Workforce Management time repository. -
timeStatuses: array
Time Statuses
Title:
Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API. -
unitOfMeasure: string
Read Only:
true
Maximum Length:80
Unit of measure for the time record, such as hours or units.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Attributes
Type:
array
Title:
Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
Show Source
Nested Schema : Time Messages
Type:
array
Title:
Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
Show Source
Nested Schema : Time Statuses
Type:
array
Title:
Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
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 : timeRecordGroups-timeRecords-timeAttributes-item-response
Type:
Show Source
object
-
attributeId: number
Read Only:
true
Unique identifier for the time record group attribute. -
attributeName: string
Read Only:
true
Maximum Length:240
Name of the time record group attribute, such as Comment. -
attributeType: string
Read Only:
true
Maximum Length:240
Type for the time record group attribute, such as Varchar. -
attributeValue: string
Read Only:
true
Maximum Length:240
Value for the time record group attribute, such as a comment text. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
timeBuildingBlockId: number
Read Only:
true
Unique identifier for the time record group with the specified attributes. -
timeBuildingBlockVersion: integer
(int32)
Read Only:
true
Version number for the time record group with the specified attributes.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : timeRecordGroups-timeRecords-timeMessages-item-response
Type:
Show Source
object
-
allowedException: string
Read Only:
true
Maximum Length:1
Indicates whether to allow the exception associated with the time record group. Valid values are true and false. The default value is false. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messageCode: string
Read Only:
true
Maximum Length:256
Code for the message associated with the time record group. -
messageId: integer
(int64)
Read Only:
true
Unique identifier for the message associated with the time record group. -
messageText: string
Read Only:
true
Maximum Length:240
Text for the message associated with the time record group. -
ruleId: integer
(int64)
Read Only:
true
Unique identifier for the rule from which messages were generated. -
ruleSetId: integer
(int64)
Read Only:
true
Unique identifier for the rule set containing the rules from which messages were generated. -
ruleSetType: string
Read Only:
true
Maximum Length:32
Type of the rule set containing the rules that messages were generated from, such as TCR for time calculation rule. -
severity: string
Read Only:
true
Maximum Length:30
Severity for the message associated with the time record group. -
tag: string
Read Only:
true
Maximum Length:120
Label attached to the message related to the time record group for identification. -
timeBuildingBlockId: integer
(int64)
Read Only:
true
Unique identifier for the time record group with the specified messages. -
timeBuildingBlockVersion: integer
(int32)
Read Only:
true
Version number for the time record group with the specified messages. -
timeMessageTokens: array
Time Message Tokens
Title:
Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Message Tokens
Type:
array
Title:
Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
Show Source
Nested Schema : timeRecordGroups-timeRecords-timeMessages-timeMessageTokens-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messageId: integer
(int64)
Read Only:
true
Unique identifier for the message of the defined token. -
messageTokenId: integer
(int64)
Read Only:
true
Unique identifier for the message token. -
tokenName: string
Read Only:
true
Maximum Length:256
Name of the token for the message associated with the time record group. -
tokenValue: string
Read Only:
true
Maximum Length:256
Value for the token of the message associated with the time record group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : timeRecordGroups-timeRecords-timeStatuses-item-response
Type:
Show Source
object
-
displayValue: string
Read Only:
true
Maximum Length:80
Value displayed for the time record group status, such as Submitted. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
statusCode: string
Read Only:
true
Maximum Length:32
Code for the time record group status, such as D_TM_UI_STATUS for Time Card UI status. -
statusId: integer
(int64)
Read Only:
true
Unique identifier for the time record group status. -
statusName: string
Read Only:
true
Maximum Length:255
Name of the time record group status, such as Time Card UI Status. -
statusValue: string
Read Only:
true
Maximum Length:30
Value for the time record group status, such as SUBMITTED. -
timeBuildingBlockId: integer
(int64)
Read Only:
true
Unique identifier for the time record group with the specified status. -
timeBuildingBlockVersion: integer
(int32)
Read Only:
true
Version number for the time record group with the specified status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source