Retrieve Additional Information

This is the third step in the sequence of processing steps that the REST API client executes. The client may need to obtain additional information for applicable tasks by following the AdditionalInformation link (if present) returned in the response for individual tasks.

Retrieve Person Transaction Details

For transactions related to person, the REST client calls the publicWorkers resource.

To retrieve the person transaction details:

1. Query the person record by performing a GET operation on the publicWorkers resource using the person identifier.
2. Verify the transaction details returned in the response.

Example URL

The following is the format of the resource URL.

GET

/hcmRestApi/resources/11.13.18.05/publicWorkers/100000008153770

Example Response

The following is an example of the response body in JSON format.

{
  "PersonId": 100000008153770,
  "PersonNumber": "8153770",
  "HireDate": "2001-08-10",
  "FirstName": "Arun",
  "LastName": "Ramakrishnan",
  "MiddleNames": null,
  "KnownAs": null,
  "DisplayName": "Arun Ramakrishnan",
  "Honors": null,
  "Suffix": null,
  "Title": "MR.",
  "PreNameAdjunct": null,
  "EmailAddress": "[e-mail]",
  "Username": "TM-ARAMAKRISHNAN",
  "ImageName": "8153770"
  ...
}

Retrieve Absences Details

For transactions related to absences, the REST client calls the absences resource.

To retrieve the absences transaction details:

1. Query the absences record by performing a GET operation on the absences resource using the absence entry identifier.
2. Verify the transaction details returned in the response.

Example URL

The following is the format of the resource URL.

GET

/hcmRestApi/resources/11.13.18.05/absences/300100155148633

Example Response

The following is an example of the response body in JSON format.

{
  "duration": 9,
  "endDate": "2018-02-26",
  "personAbsenceEntryId": 300100155148633,
  "startDate": "2018-02-26",
  ...
}

Retrieve Time Record Groups Details

For transactions related to time approvals, the REST client calls the timeRecordGroups resource.

To retrieve the time approvals transaction details:

1. Query the absences record by performing a GET operation on the timeRecordGroups resource using the time record group identifier.
2. Verify the transaction details returned in the response.

Example URL

The following is the format of the resource URL.

GET

/hcmRestApi/resources/11.13.18.05/timeRecordGroups/300100164599768

Example Response

The following is an example of the response body in JSON format.

{
  "timeRecordGroupId": 300100164599768,
  "parentTimeRecordGroupId": null,
  "startTime": "2013-08-26T08:00:00+00:00",
  "stopTime": "2014-12-31T17:00:00+00:00",
  ...
}

Retrieve Alert Notifications

For alert notifications, the REST client follows the link to retrieve the notification message body which is returned as an XML content type.

To retrieve an alert notification:

1. Perform a GET operation on the BPM tasks resource by providing the identification key and the expand parameter.
2. Verify the notification details returned in the response.

Example URL

The following is the format of the resource URL.

GET

/bpm/api/4.0/tasks?identificationKey=ALERT:300100161297000&payloadFlag=true

Example Response

The following is an example of the response body in JSON format.

{
  ...
  "count": 1,
  "items": [
      {
          ...
          "payload": {
              "rawPayload": "<payload xmlns=\"http://xmlns.oracle.com/bpel/workflow/task\"><notificationDetail xmlns=\"http://xmlns.oracle.com/apps/hcm/common/core/alerts\"> Compliance alert - no time entry found for Susan King from 2018-02-20 to 2018-02-21…</notificationDetail>\n</payload>\n"
          }
          ...
    ]
}