1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Time Event Requests

Create a time event request

post

/hcmRestApi/resources/11.13.18.05/timeEventRequests

Request

Header Parameters
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
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 : timeEventRequests-timeEvents-item-post-request
Type: object
Show Source
  • Maximum Length: 40
    Identifier for the time collection device used to create the time event.
  • 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.
  • Maximum Length: 80
    Identifier for the worker recording the time event with the time collection device.
  • 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.
  • 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.
  • 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.
  • Unique identifier for the In or Out time event that the time reporter records using a time collection device.
  • 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 : 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 : schema
Type: object
Show Source
  • 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.
  • Maximum Length: 240
    Name of the attribute associated with the time event, such as Payroll Time Type.
  • 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.
  • Unique identifier for the In or Out time event that the time reporter records using a time collection device.
  • Maximum Length: 150
    Value for the time event attribute, for example, Regular is a value for the Payroll Time Type time attribute.
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 : timeEventRequests-item-response
Type: object
Show Source
  • Links
  • Maximum Length: 80
    Unique identifier for the time event request sent by the time collection device supplier.
  • Maximum Length: 80
    Date and time when the time event request was created.
  • Maximum Length: 40
    Unique identifier for the source creating the data, for example, supplier name or facility identifier.
  • Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.
  • 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 : 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 : timeEventRequests-timeEvents-item-response
Type: object
Show Source
  • Maximum Length: 40
    Identifier for the time collection device used to create the time event.
  • 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
  • Maximum Length: 80
    Identifier for the worker recording the time event with the time collection device.
  • 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.
  • 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.
  • 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.
  • Unique identifier for the In or Out time event that the time reporter records using a time collection device.
  • 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 : 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: object
Show Source
  • 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
  • Maximum Length: 240
    Name of the attribute associated with the time event, such as Payroll Time Type.
  • 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.
  • Unique identifier for the In or Out time event that the time reporter records using a time collection device.
  • Maximum Length: 150
    Value for the time event attribute, for example, Regular is a value for the Payroll Time Type time attribute.
Links
timeEvents
Parameters:
  • 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.
Back to Top

Examples

The following example shows how to create a time event request by submitting a POST request on the REST resource using cURL.

cURL Command

curl --user <username>:<password> -X POST -H "Content-type:application/vnd.oracle.adf.resourceitem+json" -d '{"sourceId":"ACT","requestNumber":"1200220335","requestTimestamp":"2015-01-12T08:00:00.000-08:00","timeEvents":[{"reporterIdType":"PERSON","supplierDeviceEvent":"ACT_OUT","eventDateTime":"2015-01-12T08:00:00.000-08:00","reporterId":"100000017107211","deviceId":"222"}]}' <host>:<port>/hcmRestApi/resources/11.13.18.05/timeEventRequests

Example of Payload

The following shows an example of the payload: 
{
         "requestNumber": "20283",
         "sourceId": "879986",
         "requestTimestamp": "2015-10-16T08:01:00.000+01:00",
         "timeEvents": [
            {
               "deviceId": "111",
               "eventDateTime": "2015-10-16T08:00:00.000+01:00",
               "supplierDeviceEvent": "PUNCH_IN",
               "reporterId": "1000",
               "reporterIdType": "PERSON",
               "timeEventAttributes": [
                  {
                     "name": "PayrollTimeType",
                     "value": "Regular",
                  }
               ]
            }
         ]
}

Example of Response Header

The following shows an example of the response header:

Status: HTTP/1.1 201 Created
Content-Type: application/json

Example of Response Body

The following example shows the content of the response body in JSON format:

{
"timeEventRequestId": 300100073599166,
"requestNumber": "20283",
"requestTimestamp": "2017-09-02T01:12:39.000+01:00",
"sourceId": "879986",
"timeEvents": [
  {
"timeEventId": 300100073599167,
"timeEventRequestId": 300100073599166,
"eventDateTime": "2015-10-16T08:01:00.000+01:00",
"deviceId": "111",
"supplierDeviceEvent": "PUNCH_IN",
"reporterId": "1000",
"reporterIdType": "PERSON",
"links": [
  ...
	],
}
Back to Top