Get a time event request
get
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}
Request
Path Parameters
-
timeEventRequestId(required): integer(int64)
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : timeEventRequests-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
requestNumber: string
Maximum Length:
80
Unique identifier for the time event request sent by the time collection device supplier. -
requestTimestamp: string
Maximum Length:
80
Date and time when the time event request was created. -
sourceId: string
Maximum Length:
40
Unique identifier for the source creating the data, for example, supplier name or facility identifier. -
timeEventRequestId: integer
(int64)
Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.
-
timeEvents: array
Time Events
Title:
Time Events
The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Events
Type:
array
Title:
Time Events
The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.
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 : timeEventRequests-timeEvents-item-response
Type:
Show Source
object
-
deviceId: string
Maximum Length:
40
Identifier for the time collection device used to create the time event. -
eventDateTime: string
Maximum Length:
150
Date and time when the time event was recorded by the time collection device. The time stamp in the request must use the ISO 8601 standard with the time zone offset information. The attribute can handle either a start or end time or a start time and duration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
reporterId: string
Maximum Length:
80
Identifier for the worker recording the time event with the time collection device. -
reporterIdType: string
Maximum Length:
30
Type of reporter identifier that the time reporter uses with the time collection device. Valid values, defined in the ReporterIDTypeList1 list, are: BADGE, PERSON, PERSONID, and ASSIGNMENT. -
supplierDeviceEvent: string
Maximum Length:
40
Supplier-recognized time events mapped to Workforce Management application events. For example, the supplier device event Clock In is mapped to the application event In. Valid values are defined in the ORA_HWM_TCD_SUPPLIER_EVENTS lookup type. The lookup codes are user defined. -
timeEventAttributes: array
Time Event Attributes
Title:
Time Event Attributes
The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid. -
timeEventId: integer
(int64)
Unique identifier for the In or Out time event that the time reporter records using a time collection device.
-
timeEventRequestId: integer
(int64)
Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Event Attributes
Type:
array
Title:
Time Event Attributes
The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid.
Show Source
Nested Schema : timeEventRequests-timeEvents-timeEventAttributes-item-response
Type:
Show Source
object
-
facet: string
Maximum Length:
150
Attribute identifying the In or Out time event of a paired device event. Used to default a qualifier only on the In or Out facet. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
name: string
Maximum Length:
240
Name of the attribute associated with the time event, such as Payroll Time Type. -
timeEventAttributeId: integer
(int64)
Qualifier associated with the time event that reflects how the time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates whether time for payroll consumers should be paid.
-
timeEventId: integer
(int64)
Unique identifier for the In or Out time event that the time reporter records using a time collection device.
-
value: string
Maximum Length:
150
Value for the time event attribute, for example, Regular is a value for the Payroll Time Type time attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- timeEvents
-
Operation: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEventsParameters:
- timeEventRequestId:
$request.path.timeEventRequestId
The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device. - timeEventRequestId: