Get all time cards
get
/hcmRestApi/resources/11.13.18.05/timeCardsLOV
Request
Query Parameters
-
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 time cards using the specified primary key criteria.
Finder Variables- timeRecordGroupId; integer; Unique identifier for the time record group containing the time cards.
- filterByGroupType Finds time cards using the group type.
Finder Variables- groupType; string; Layer where time cards in the time record group are retrieved from, such as processed time card or posted schedule day.
- filterByPerIdTimeGrp Finds time cards using the person identifier and the group type.
Finder Variables- groupType; string; Layer where time cards in the time record group are retrieved from, such as processed time card or posted schedule day.
- personId; integer; Unique identifier for the person associated with the time cards.
- startTime; string; Start time for the range containing the time cards to retrieve.
- stopTime; string; End time for the range containing the time cards to retrieve.
- filterByPerNumTimeGrp Finds time cards using the person number and the group type.
Finder Variables- groupType; string; Layer where time cards in the time record group are retrieved from, such as processed time card or posted schedule day.
- personNumber; string; Unique number for the person associated with the time cards.
- startTime; string; Start time for the range containing the time cards to retrieve.
- stopTime; string; End time for the range containing the time cards to retrieve.
- filterByTmRecGrpId Finds time cards using the identifier of the time record group containing the time cards.
Finder Variables- timeRecordGroupId; integer; Unique identifier for the time record group containing the time cards.
- findByWord Finds the time cards that match the specified search criteria.
Finder Variables- DateFormatPattern; string; User-preferred format for dates.
- FilterAttributes; string; Attributes from the specified search terms.
- SearchTerms; string; Search criteria to use to find specific time cards.
- favoriteName; string; User-defined name for each time card.
- personId; integer; Unique identifier for the person associated with the time cards.
- startTime; string; Start time for the range containing the time cards to retrieve.
- stopTime; string; End time for the range containing the time cards to retrieve.
- timeRecordGroupId; integer; Unique identifier for the time record group containing the time cards.
- totalHours; string; Total number of hours reported on each time card.
- PrimaryKey Finds time cards using 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:- DateFormatPattern; string; User-preferred format for time card dates.
- assignmentNumber; string; Assignment number for the person associated with the time cards.
- comment; string; Comment associated with the time cards.
- favoriteIcon; string; Identifier for the favorite icon.
- favoriteName; string; User-defined name for each time card.
- groupType; string; Layer where time cards in the time record group are retrieved from, such as processed time card or posted schedule day.
- parentTimeRecordGroupId; integer; Unique identifier for the time record group parent.
- parentTimeRecordGroupVersion; integer; Version number for the time record group parent stored in the Workforce Management time repository.
- personId; integer; Unique identifier for the person associated with the time cards.
- personNumber; string; Number for the person associated with the time cards.
- startDate; string; Start date for the range containing the time cards to retrieve.
- startTime; string; Start time for the range containing the time cards to retrieve.
- stopDate; string; End date for the range containing the time cards to retrieve.
- stopTime; string; End time for the range containing the time cards to retrieve.
- timeRecordGroupId; integer; Unique identifier for the time record group containing the time cards.
- timeRecordGroupVersion; integer; Version number for the time record group stored in the Workforce Management time repository.
- timecardPeriod; string; Time card period for each time card retrieved.
- totalHours; number; Total number of hours reported on each time card.
-
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 : timeCardsLOV
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 : timeCardsLOV-item-response
Type:
Show Source
object
-
assignmentNumber: string
Read Only:
true
Maximum Length:50
Assignment number for the person associated with the time cards. -
comment: string
Read Only:
true
Maximum Length:2000
Comment associated with the time cards. -
DateFormatPattern: string
User-preferred format for time card dates.
-
favoriteIcon: string
Read Only:
true
Identifier for the favorite icon. -
favoriteName: string
Read Only:
true
Maximum Length:150
User-defined name for each time card. -
groupType: string
Read Only:
true
Maximum Length:255
Layer where time cards in the time record group are retrieved from, such as processed time card or posted schedule day. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
parentTimeRecordGroupId: integer
(int64)
Read Only:
true
Unique identifier for the time record group parent. -
parentTimeRecordGroupVersion: integer
(int32)
Read Only:
true
Version number for the time record group parent stored in the Workforce Management time repository. -
personId: integer
(int64)
Read Only:
true
Unique identifier for the person associated with the time cards. -
personNumber: string
Read Only:
true
Maximum Length:30
Number for the person associated with the time cards. -
startDate: string
(date)
Read Only:
true
Start date for the range containing the time cards to retrieve. -
startTime: string
(date-time)
Read Only:
true
Start time for the range containing the time cards to retrieve. -
stopDate: string
(date)
Read Only:
true
End date for the range containing the time cards to retrieve. -
stopTime: string
(date-time)
Read Only:
true
End time for the range containing the time cards to retrieve. -
timecardPeriod: string
Read Only:
true
Time card period for each time card retrieved. -
timeRecordGroupId: integer
Read Only:
true
Unique identifier for the time record group containing the time cards. -
timeRecordGroupVersion: integer
(int32)
Read Only:
true
Version number for the time record group stored in the Workforce Management time repository. -
totalHours: number
Read Only:
true
Total number of hours reported on each time card.
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.