Create a time record event request
post
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
processInline: string
Maximum Length:
30
Indicator on the time record event request that determines whether to process the time record events inline or asynchronously. -
processMode: string
Maximum Length:
20
Mode - Save, Submit, or Enter - for processing time records that are stored in the WFM time repository. -
timeRecordEvent: array
Time Record Events
Title:
Time Record Events
The timeRecordEvents resource is a child of the time record event requests resource. It's a unique identifier of a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed. -
timeRecordEventRequestId: integer
(int64)
Unique identifier for the time record event request.
Nested Schema : Time Record Events
Type:
array
Title:
Time Record Events
The timeRecordEvents resource is a child of the time record event requests resource. It's a unique identifier of a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
assignmentNumber: string
Assignment number for the person associated with the time record event. Valid values are defined in the lookup AssignmentPVO1.
-
changeReason: string
Maximum Length:
64
Reason for the change associated with the time record event for audit purposes, such as missing time entry or incorrect time entry. Valid values are defined in the lookup HcmLookupPVO1. These lookup codes are added by the customer. -
comment: string
Maximum Length:
1000
Comment associated with the time record event. -
crudStatusValue: integer
Numerical value of the type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
-
eventStatus: string
Processing status of the time record event, such as New, In process, or Complete.
-
eventStatusValue: integer
Numerical value of the processing status, such as New, In process or Complete, of the time record event.
-
measure: number
Quantity of the time record event that can be a number of hours or units.
-
operationType: string
Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
-
personId: string
Unique identifier for the person associated with the time record event.
-
referenceDate: string
(date)
Date to use to process a time record event that spans multiple days.
-
reporterId: string
Maximum Length:
80
Unique identifier for the worker associated with the time record event. -
reporterIdType: string
Maximum Length:
20
Type of identifier for the time reporter, such as Person or Badge. -
startTime: string
Maximum Length:
150
Start time of the time record event to import. -
stopTime: string
Maximum Length:
150
End time of the time record event to import. -
subresourceId: integer
Identifier for the work assignment for the person associated with the time record event.
-
timeRecordEventAttribute: array
Time Record Event Attributes
Title:
Time Record Event Attributes
The timeRecordEventAttribute resource is the child of the time record events resource, and the granchild of the time record event requests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the payroll time type attribute indicates how the payroll consumer processes the associated time.. -
timeRecordEventId: integer
Unique identifier for the time record event.
-
timeRecordEventMessage: array
Time Record Event Messages
Title:
Time Record Event Messages
The timeRecordEventMessage resource is a child of the time record events attribute, and the granchild of the time record event requests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations. -
timeRecordEventRequestId(required): integer
Unique identifier for the time record event request.
-
timeRecordId: integer
Unique identifier for the time record to update or delete.
-
timeRecordVersion: integer
Version number of the time record stored in the WFM time repository.
Nested Schema : Time Record Event Attributes
Type:
array
Title:
Time Record Event Attributes
The timeRecordEventAttribute resource is the child of the time record events resource, and the granchild of the time record event requests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the payroll time type attribute indicates how the payroll consumer processes the associated time..
Show Source
Nested Schema : Time Record Event Messages
Type:
array
Title:
Time Record Event Messages
The timeRecordEventMessage resource is a child of the time record events attribute, and the granchild of the time record event requests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.
Show Source
Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-post-request
Type:
Show Source
object
-
attributeName: string
Maximum Length:
240
Name of the attribute to import with the time record event, such as Payroll Time Type. Valid values are defined in the lookup TimeAttibuteFieldPVO1. -
attributeValue: string
Maximum Length:
150
Value of the attribute to import with the time record event, such as Regular or Overtime. -
changeReason: string
Maximum Length:
64
Reason for the change associated with the time record event attribute for audit purposes, such as missing time entry or incorrect time entry. The valid values are defined in the lookup HcmLookupPVO1. These lookup codes are added by the customer. -
timeAttributeFieldId: integer
(int64)
Unique identifier for the field that the time attribute is associated with.
-
timeRecordEventAttributeId: integer
(int64)
Unique identifier for the time record event attribute.
-
timeRecordEventId: integer
Unique identifier for the time record event.
Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-post-request
Type:
Show Source
object
-
allowException: string
Maximum Length:
1
Indicator that determines whether to allow the exception associated with the time record. -
attributeType: string
Maximum Length:
20
Type of the attribute the message is related to, such as Timestamp for startTime. -
messageField: string
Maximum Length:
256
Unique identifier for the field that the message is associated with. -
messageId: integer
(int64)
Unique identifier for the message associated with the time record.
-
messageName: string
Maximum Length:
256
Name of the message associated with the time record. -
timeBldgBlkVersion: integer
(int32)
Version number of the time record event with specified message.
-
timeRecordEventMessageId: integer
(int64)
Unique identifier for the message associated with the time record event.
-
timeRecordId: integer
(int64)
Unique identifier for the time record associated with the message.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : timeRecordEventRequests-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
processInline: string
Maximum Length:
30
Indicator on the time record event request that determines whether to process the time record events inline or asynchronously. -
processMode: string
Maximum Length:
20
Mode - Save, Submit, or Enter - for processing time records that are stored in the WFM time repository. -
timeRecordEvent: array
Time Record Events
Title:
Time Record Events
The timeRecordEvents resource is a child of the time record event requests resource. It's a unique identifier of a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed. -
timeRecordEventRequestId: integer
(int64)
Unique identifier for the time record event request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Record Events
Type:
array
Title:
Time Record Events
The timeRecordEvents resource is a child of the time record event requests resource. It's a unique identifier of a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.
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 : timeRecordEventRequests-timeRecordEvent-item-response
Type:
Show Source
object
-
assignmentNumber: string
Assignment number for the person associated with the time record event. Valid values are defined in the lookup AssignmentPVO1.
-
changeReason: string
Maximum Length:
64
Reason for the change associated with the time record event for audit purposes, such as missing time entry or incorrect time entry. Valid values are defined in the lookup HcmLookupPVO1. These lookup codes are added by the customer. -
comment: string
Maximum Length:
1000
Comment associated with the time record event. -
crudStatusValue: integer
Numerical value of the type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
-
eventStatus: string
Processing status of the time record event, such as New, In process, or Complete.
-
eventStatusValue: integer
Numerical value of the processing status, such as New, In process or Complete, of the time record event.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measure: number
Quantity of the time record event that can be a number of hours or units.
-
operationType: string
Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
-
personId: string
Unique identifier for the person associated with the time record event.
-
referenceDate: string
(date)
Date to use to process a time record event that spans multiple days.
-
reporterId: string
Maximum Length:
80
Unique identifier for the worker associated with the time record event. -
reporterIdType: string
Maximum Length:
20
Type of identifier for the time reporter, such as Person or Badge. -
startTime: string
Maximum Length:
150
Start time of the time record event to import. -
stopTime: string
Maximum Length:
150
End time of the time record event to import. -
subresourceId: integer
Identifier for the work assignment for the person associated with the time record event.
-
timeRecordEventAttribute: array
Time Record Event Attributes
Title:
Time Record Event Attributes
The timeRecordEventAttribute resource is the child of the time record events resource, and the granchild of the time record event requests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the payroll time type attribute indicates how the payroll consumer processes the associated time.. -
timeRecordEventId: integer
Unique identifier for the time record event.
-
timeRecordEventMessage: array
Time Record Event Messages
Title:
Time Record Event Messages
The timeRecordEventMessage resource is a child of the time record events attribute, and the granchild of the time record event requests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations. -
timeRecordEventRequestId: integer
Unique identifier for the time record event request.
-
timeRecordId: integer
Unique identifier for the time record to update or delete.
-
timeRecordVersion: integer
Version number of the time record stored in the WFM time repository.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Record Event Attributes
Type:
array
Title:
Time Record Event Attributes
The timeRecordEventAttribute resource is the child of the time record events resource, and the granchild of the time record event requests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the payroll time type attribute indicates how the payroll consumer processes the associated time..
Show Source
Nested Schema : Time Record Event Messages
Type:
array
Title:
Time Record Event Messages
The timeRecordEventMessage resource is a child of the time record events attribute, and the granchild of the time record event requests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.
Show Source
Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-response
Type:
Show Source
object
-
attributeName: string
Maximum Length:
240
Name of the attribute to import with the time record event, such as Payroll Time Type. Valid values are defined in the lookup TimeAttibuteFieldPVO1. -
attributeValue: string
Maximum Length:
150
Value of the attribute to import with the time record event, such as Regular or Overtime. -
changeReason: string
Maximum Length:
64
Reason for the change associated with the time record event attribute for audit purposes, such as missing time entry or incorrect time entry. The valid values are defined in the lookup HcmLookupPVO1. These lookup codes are added by the customer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
timeAttributeFieldId: integer
(int64)
Unique identifier for the field that the time attribute is associated with.
-
timeRecordEventAttributeId: integer
(int64)
Unique identifier for the time record event attribute.
-
timeRecordEventId: integer
Unique identifier for the time record event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-response
Type:
Show Source
object
-
allowException: string
Maximum Length:
1
Indicator that determines whether to allow the exception associated with the time record. -
attributeType: string
Maximum Length:
20
Type of the attribute the message is related to, such as Timestamp for startTime. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messageField: string
Maximum Length:
256
Unique identifier for the field that the message is associated with. -
messageId: integer
(int64)
Unique identifier for the message associated with the time record.
-
messageName: string
Maximum Length:
256
Name of the message associated with the time record. -
timeBldgBlkVersion: integer
(int32)
Version number of the time record event with specified message.
-
timeRecordEventMessageId: integer
(int64)
Unique identifier for the message associated with the time record event.
-
timeRecordId: integer
(int64)
Unique identifier for the time record associated with the message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- timeRecordEvent
-
Parameters:
- timeRecordEventRequestId:
$request.path.timeRecordEventRequestId
The timeRecordEvents resource is a child of the time record event requests resource. It's a unique identifier of a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed. - timeRecordEventRequestId:
Examples
The following example shows how to create a time record event request by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://host:port/hcmResti'll Api/resources/11.13.18.05/timeRecordEventRequests
Example of Payload
The following is an example of the payload.
{ "processInline": "N", "processMode": "TIME_SUBMIT", "timeRecordEvent": [{ "startTime":"2017-11-07T13:00:00.000-08:00", "stopTime":"2017-11-07T16:00:00.000-08:00", "reporterIdType":"PERSON", "reporterId":"955160008182127", "assignmentNumber":"10", "comment":"Missing entry due to clock down", "operationType":"ADD", "timeRecordEventAttribute": [{ "attributeName":"PayrollTimeType", "attributeValue":"ZOTL_Regular" }] }] }
Example of Response Header
The following is an example of the response header.
HTTP/1.1 201 Created Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "timeRecordEventRequestId": 300100145540850, "processMode": "TIME_SUBMIT", "processInline": "Y", "timeRecordEvent": [ { "comment": "Missing entry due to clock down", "crudStatusValue": 0, "personId": "300100074978533", "referenceDate": null, "reporterId": "955160008184353", "reporterIdType": "PERSON", "startTime": "2017-11-07T13:00:00.000-08:00", "stopTime": "2017-11-07T16:00:00.000-08:00", "subresourceId": null, "timeRecordEventId": 300100145540851, "timeRecordEventRequestId": 300100145540850, "timeRecordId": null, "timeRecordVersion": null, "operationType": "ADD", "assignmentNumber": "10", "eventStatusValue": 5, "eventStatus": "COMPLETE", "measure": null, "changeReason": null, "timeRecordEventAttribute": [ { "timeAttributeFieldId": 300100028326158, "timeRecordEventAttributeId": 300100145540852, "timeRecordEventId": 300100145540851, "attributeValue": "ZOTL_Regular", "attributeName": "PayrollTimeType", "changeReason": null, "links": [...] }