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

Get a time record event

get

/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}

Request

Path Parameters
  • 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=
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : timeRecordEventRequests-timeRecordEvent-item-response
Type: object
Show Source
  • Assignment number for the person associated with the time record event. Valid values are defined in the AssignmentPVO1 lookup type.
  • Maximum Length: 64
    Reason for the audited change associated with the time record event, such as missing time entry or incorrect time entry. Valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.
  • Maximum Length: 1000
    Comment associated with the time record event.
  • Numeric value for the type of operation, such as 1 for Create, 2 for Update, or 3 for Delete, to apply when importing the time record event.
  • Processing status for the time record event, such as New, In process, or Complete.
  • Numeric value for the processing status, such as 0 for New, 4 for In process, or 5 for Complete, of the time record event.
  • Links
  • Quantity, in hours or units, for the time record event.
  • Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
  • Unique identifier for the person associated with the time record event.
  • Date to use to process a time record event that spans multiple days.
  • Maximum Length: 80
    Unique identifier for the worker associated with the time record event.
  • Maximum Length: 20
    Type of identifier for the time reporter, such as Person or Badge.
  • Maximum Length: 150
    Start time for the time record event to import.
  • Maximum Length: 150
    End time for the time record event to import.
  • Identifier for the work assignment of the person associated with the time record event.
  • Time Record Event Attributes
    Title: Time Record Event Attributes
    The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests 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..
  • Unique identifier for the time record event.
  • Time Record Event Messages
    Title: Time Record Event Messages
    The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests 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.
  • Unique identifier for the time record event request.
  • Unique identifier for the time record to update or delete.
  • Version number for the time record stored in the Workforce Management time repository.
Nested Schema : Time Record Event Attributes
Type: array
Title: Time Record Event Attributes
The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests 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 timeRecordEvents attribute and the grandchild of the timeRecordEventRequests 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: object
Show Source
Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-response
Type: object
Show Source
Links
timeRecordEventAttribute
Parameters:
  • timeRecordEventId: $request.path.timeRecordEventId
  • timeRecordEventRequestId: $request.path.timeRecordEventRequestId
The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests 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..
timeRecordEventMessage
Parameters:
  • timeRecordEventId: $request.path.timeRecordEventId
  • timeRecordEventRequestId: $request.path.timeRecordEventRequestId
The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests 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.
Back to Top

Examples

The following example shows how to retrieve a time record event by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeStartDate=2010-10-12" -X GET -d <payload> https://host:port/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200  OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "comment": "Simple Create",
    "crudStatusValue": 0,
    "personId": "300100039378610",
    "referenceDate": null,
    "reporterId": "955160008179445",
    "reporterIdType": "PERSON",
    "startTime": "2017-02-08T09:00:00.000-08:00",
    "stopTime": "2017-02-08T17:00:00.000-08:00",
    "subresourceId": null,
    "timeRecordEventId": 300100123220030,
    "timeRecordEventRequestId": 300100123220029,
    "timeRecordId": null,
    "timeRecordVersion": null,
    "operationType": "ADD",
    "assignmentNumber": null,
    "eventStatusValue": 5,
    "eventStatus": "COMPLETE",
    "measure": null,
    "changeReason": null,
    "links": [...]
 }
Back to Top