Manage Absences

You may be using a third-party absence management application to allow employees to request or record absences. You may want these absences to reflect on Oracle HCM Cloud while your employees continue to use a third-party application for absence entry. You can use the absences REST service to create, update, and retrieve absences.
This use case discusses the following scenarios:
  • Request Time Off for Vacation
  • Reschedule a Vacation Required
  • Retrieve a Single Absence Record
  • Retrieve Multiple Absence Records

A typical application flow for these scenarios is as follows:

  1. You configure absence plans according to the business needs of your organization.
  2. You specify the eligibility criteria on the absence plan to ensure employees meeting the criteria automatically get enrolled to the absence plans, or you manually enroll employees to specific absence plans.
  3. You configure absence types according to the business needs of your organization, and include the new absence plans you have created into the absence types.
  4. When an absence is requested or updated in the third-party absence management application, the application makes a call to Oracle HCM Absences REST service.

Let's take the following example to illustrate how this REST service works.

Jen works as a customer service executive in a grocery retail chain. The organization has enrolled Jen into appropriate absence plans she is eligible for. One of these plans is Vacation, and Jen accrues 10 hrs of vacation every month. Let's look at how Jen requests time-off for vacation, and then reschedules it.

When Jen submits a vacation request, she does it against an absence type. This absence type can be linked to one or more absence plans. Absence Management processes the absence request by checking accrued balance, and applying appropriate rules put in place by her company's Human Resources.

Request Time Off for Vacation

To submit an absence request, the client application executes a POST operation on the URL for the Absences REST resource. The absence request for the employee is then available in Oracle HCM Cloud.

For example, Jen requests a vacation for 5 days starting Nov 19, 2018 to Nov 23, 2018. This creates a new record in Oracle HCM Cloud.

Example URL

The following is the format of the resource URL.

POST

/hcmRestApi/resources/11.13.18.05/absences

Example Request

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

{ 
    "personNumber": "300100010469552", 
    "employer": "ZBEN USA", 
    "absenceType": "ANC_ZBEN_US_P1_VACATIONTYPE", 
    "startDate": "2018-11-19", 
    "startTime": "08:00", 
    "endDate": "2018-11-23",
    "endTime": "17:00",
    "absenceStatusCd": "SUBMITTED"
}

Example Response

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

{
    "absenceCaseId": null,
    "absenceEntryBasicFlag": true,
    "absencePatternCd": "GENERIC",
    "absenceStatusCd": "SUBMITTED",
    "absenceTypeId": 300100036660807,
    "absenceTypeReasonId": null,
    "agreementId": null,
    "approvalStatusCd": "APPROVED",
    "authStatusUpdateDate": null,
    "bandDtlId": null,
    "blockedLeaveCandidate": null,
    "certificationAuthFlag": null,
    "childEventTypeCd": null,
    "comments": null,
    "conditionStartDate": null,
    "confirmedDate": null,
    "consumedByAgreement": null,
    "createdBy": "ZANC_ZBEN_SUPER_USER",
    "creationDate": "2018-08-13T08:23:17+00:00",
    "diseaseCode": null,
    "duration": 5,
    "employeeShiftFlag": false,
    "endDate": "2018-11-23",
    "endDateDuration": null,
    "endDateTime": "2018-11-23T17:00:00+00:00",
    "endTime": "17:00",
    "establishmentDate": null,
    "frequency": null,
    "initialReportById": null,
    "initialTimelyNotifyFlag": null,
    "lastUpdateDate": "2018-08-13T08:23:19.635+00:00",
    "lastUpdateLogin": "7349341640754B5CE05333D6F00A322B",
    "lastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
    "lateNotifyFlag": null,
    "legalEntityId": 100000011627095,
    "legislationCode": "US",
    "legislativeDataGroupId": 100010027007980,
    "notificationDate": null,
    "objectVersionNumber": 2,
    "openEndedFlag": false,
    "overridden": "N",
    "personAbsenceEntryId": 300100159592743,
    "periodOfIncapToWorkFlag": null,
    "periodOfServiceId": 300100032404496,
    "personId": 300100032404256,
    "plannedEndDate": null,
    "processingStatus": "P",
    "projectId": null,
    "singleDayFlag": false,
    "source": "REST",
    "splCondition": null,
    "startDate": "2018-11-19",
    "startDateDuration": null,
    "startDateTime": "2018-11-19T08:00:00+00:00",
    "startTime": "08:00",
    "submittedDate": "2018-08-13",
    "timelinessOverrideDate": null,
    "unitOfMeasure": "D",
    "userMode": "EMP",
    "personNumber": "300100010469552",
    "absenceType": "ANC_ZBEN_US_P1_VACATIONTYPE",
    "employer": "ZBEN USA",
    "absenceReason": null,
    "absenceDispStatus": null,
    "dataSecurityPersonId": 300100032404256,
    "effectiveEndDate": "4712-12-31",
    "effectiveStartDate": "2008-01-01",
    "ObjectVersionNumber": 2,
    "agreementName": null,
    "paymentDetail": null,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
            "name": "absences",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
            "name": "absences",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ApprovalStatusVA",
            "name": "ApprovalStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/PersonVA",
            "name": "PersonVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ChildEventTypeVA",
            "name": "ChildEventTypeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/BlockedLeaveCandidateVA",
            "name": "BlockedLeaveCandidateVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceAgreementBandDtlsVA",
            "name": "AbsenceAgreementBandDtlsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceDisplayStatusVA",
            "name": "AbsenceDisplayStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/UomMeaningVA",
            "name": "UomMeaningVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceStatusVA",
            "name": "AbsenceStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/SplConditionVA",
            "name": "SplConditionVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeAgreementsVA",
            "name": "AbsenceTypeAgreementsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeReasonsVA",
            "name": "AbsenceTypeReasonsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeVA",
            "name": "AbsenceTypeVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingsDDF",
            "name": "absenceRecordingsDDF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingDFF",
            "name": "absenceRecordingDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceMaternity",
            "name": "absenceMaternity",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceEntitlements",
            "name": "absenceEntitlements",
            "kind": "collection"
        }
    ]
}

Reschedule the Vacation Request

To reschedule an absence request, you can perform a PATCH operation on the absences resource. These updates are then reflected in Oracle HCM Cloud.

For example, Jen wants to postpone her vacation by a week. She wants to start her vacation on Nov 26, 2018 and end it on Nov 30, 2018.

Example URL

The following is the format of the resource URL.

PATCH

/hcmRestApi/resources/11.13.18.05/absences/{personAbsenceEntryId}

Example Request

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

{ 
    "startDate": "2018-11-26", 
    "endDate": "2018-11-30"
}

Example Response

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

{
    "absenceCaseId": null,
    "absenceEntryBasicFlag": true,
    "absencePatternCd": "GENERIC",
    "absenceStatusCd": "SUBMITTED",
    "absenceTypeId": 300100036660807,
    "absenceTypeReasonId": null,
    "agreementId": null,
    "approvalStatusCd": "APPROVED",
    "authStatusUpdateDate": null,
    "bandDtlId": null,
    "blockedLeaveCandidate": null,
    "certificationAuthFlag": null,
    "childEventTypeCd": null,
    "comments": null,
    "conditionStartDate": null,
    "confirmedDate": null,
    "consumedByAgreement": null,
    "createdBy": "ZANC_ZBEN_SUPER_USER",
    "creationDate": "2018-08-13T08:23:17+00:00",
    "diseaseCode": null,
    "duration": 5,
    "employeeShiftFlag": false,
    "endDate": "2018-11-30",
    "endDateDuration": null,
    "endDateTime": "2018-11-30T17:00:00+00:00",
    "endTime": "17:00",
    "establishmentDate": null,
    "frequency": null,
    "initialReportById": null,
    "initialTimelyNotifyFlag": null,
    "lastUpdateDate": "2018-08-13T08:27:33.180+00:00",
    "lastUpdateLogin": "7349341640754B5CE05333D6F00A322B",
    "lastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
    "lateNotifyFlag": null,
    "legalEntityId": 100000011627095,
    "legislationCode": "US",
    "legislativeDataGroupId": 100010027007980,
    "notificationDate": null,
    "objectVersionNumber": 3,
    "openEndedFlag": false,
    "overridden": "N",
    "personAbsenceEntryId": 300100159592743,
    "periodOfIncapToWorkFlag": null,
    "periodOfServiceId": 300100032404496,
    "personId": 300100032404256,
    "plannedEndDate": null,
    "processingStatus": "P",
    "projectId": null,
    "singleDayFlag": false,
    "source": "REST",
    "splCondition": null,
    "startDate": "2018-11-26",
    "startDateDuration": null,
    "startDateTime": "2018-11-26T08:00:00+00:00",
    "startTime": "08:00",
    "submittedDate": "2018-08-13",
    "timelinessOverrideDate": null,
    "unitOfMeasure": "D",
    "userMode": "EMP",
    "personNumber": null,
    "absenceType": null,
    "employer": null,
    "absenceReason": null,
    "absenceDispStatus": null,
    "dataSecurityPersonId": 300100032404256,
    "effectiveEndDate": "4712-12-31",
    "effectiveStartDate": "2008-01-01",
    "ObjectVersionNumber": 3,
    "agreementName": null,
    "paymentDetail": null,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
            "name": "absences",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
            "name": "absences",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ApprovalStatusVA",
            "name": "ApprovalStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/PersonVA",
            "name": "PersonVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ChildEventTypeVA",
            "name": "ChildEventTypeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/BlockedLeaveCandidateVA",
            "name": "BlockedLeaveCandidateVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceAgreementBandDtlsVA",
            "name": "AbsenceAgreementBandDtlsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceDisplayStatusVA",
            "name": "AbsenceDisplayStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/UomMeaningVA",
            "name": "UomMeaningVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceStatusVA",
            "name": "AbsenceStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/SplConditionVA",
            "name": "SplConditionVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeAgreementsVA",
            "name": "AbsenceTypeAgreementsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeReasonsVA",
            "name": "AbsenceTypeReasonsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeVA",
            "name": "AbsenceTypeVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingsDDF",
            "name": "absenceRecordingsDDF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingDFF",
            "name": "absenceRecordingDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceMaternity",
            "name": "absenceMaternity",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceEntitlements",
            "name": "absenceEntitlements",
            "kind": "collection"
        }
    ]
}

Retrieve a Single Absence Record

To retrieve a single absence record, you can query a unique identifier of the absence record.

For example, Jen wants to check the details of the vacation she has submitted. She retrieves the absence using the Person Absence Entry ID.

Example URL

The following is the format of the resource URL.

GET

/hcmRestApi/resources/11.13.18.05/absences/{personAbsenceEntryId}

Example Response

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

{
    "absenceCaseId": null,
    "absenceEntryBasicFlag": true,
    "absencePatternCd": "GENERIC",
    "absenceStatusCd": "SUBMITTED",
    "absenceTypeId": 300100036660807,
    "absenceTypeReasonId": null,
    "agreementId": null,
    "approvalStatusCd": "APPROVED",
    "authStatusUpdateDate": null,
    "bandDtlId": null,
    "blockedLeaveCandidate": null,
    "certificationAuthFlag": null,
    "childEventTypeCd": null,
    "comments": null,
    "conditionStartDate": null,
    "confirmedDate": null,
    "consumedByAgreement": null,
    "createdBy": "ZANC_ZBEN_SUPER_USER",
    "creationDate": "2018-08-13T08:23:17+00:00",
    "diseaseCode": null,
    "duration": 5,
    "employeeShiftFlag": false,
    "endDate": "2018-11-30",
    "endDateDuration": null,
    "endDateTime": "2018-11-30T17:00:00+00:00",
    "endTime": "17:00",
    "establishmentDate": null,
    "frequency": null,
    "initialReportById": null,
    "initialTimelyNotifyFlag": null,
    "lastUpdateDate": "2018-08-13T08:27:33.180+00:00",
    "lastUpdateLogin": "7349341640754B5CE05333D6F00A322B",
    "lastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
    "lateNotifyFlag": null,
    "legalEntityId": 100000011627095,
    "legislationCode": "US",
    "legislativeDataGroupId": 100010027007980,
    "notificationDate": null,
    "objectVersionNumber": 3,
    "openEndedFlag": false,
    "overridden": "N",
    "personAbsenceEntryId": 300100159592743,
    "periodOfIncapToWorkFlag": null,
    "periodOfServiceId": 300100032404496,
    "personId": 300100032404256,
    "plannedEndDate": null,
    "processingStatus": "P",
    "projectId": null,
    "singleDayFlag": false,
    "source": "REST",
    "splCondition": null,
    "startDate": "2018-11-26",
    "startDateDuration": null,
    "startDateTime": "2018-11-26T08:00:00+00:00",
    "startTime": "08:00",
    "submittedDate": "2018-08-13",
    "timelinessOverrideDate": null,
    "unitOfMeasure": "D",
    "userMode": "MGR",
    "personNumber": null,
    "absenceType": null,
    "employer": null,
    "absenceReason": null,
    "absenceDispStatus": null,
    "dataSecurityPersonId": 300100032404256,
    "effectiveEndDate": "4712-12-31",
    "effectiveStartDate": "2008-01-01",
    "ObjectVersionNumber": 3,
    "agreementName": null,
    "paymentDetail": null,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
            "name": "absences",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
            "name": "absences",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ApprovalStatusVA",
            "name": "ApprovalStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/PersonVA",
            "name": "PersonVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ChildEventTypeVA",
            "name": "ChildEventTypeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/BlockedLeaveCandidateVA",
            "name": "BlockedLeaveCandidateVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceAgreementBandDtlsVA",
            "name": "AbsenceAgreementBandDtlsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceDisplayStatusVA",
            "name": "AbsenceDisplayStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/UomMeaningVA",
            "name": "UomMeaningVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceStatusVA",
            "name": "AbsenceStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/SplConditionVA",
            "name": "SplConditionVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeAgreementsVA",
            "name": "AbsenceTypeAgreementsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeReasonsVA",
            "name": "AbsenceTypeReasonsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeVA",
            "name": "AbsenceTypeVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingsDDF",
            "name": "absenceRecordingsDDF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingDFF",
            "name": "absenceRecordingDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceMaternity",
            "name": "absenceMaternity",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceEntitlements",
            "name": "absenceEntitlements",
            "kind": "collection"
        }
    ]
}

Retrieve Multiple Absence Records

To retrieve multiple absence records, you can query a unique identifier.

For example, Gretchen is Jen's manager. She wants to retrieve all existing absences recorded of Vacation absence type for all her team members. She uses the Absence Type ID, which is the unique identifier of the vacation absence type to retrieve all vacation absence records for her team.

Example URL

The following is the format of the resource URL.

GET

/hcmRestApi/resources/11.13.18.05/absences?finder=findByAbsenceTypeId;absenceTypeId={absenceTypeId}

Example Response

{
    "items": [
        {
            "absenceCaseId": null,
            "absenceEntryBasicFlag": true,
            "absencePatternCd": "GENERIC",
            "absenceStatusCd": "SUBMITTED",
            "absenceTypeId": 300100036660807,
            "absenceTypeReasonId": null,
            "agreementId": null,
            "approvalStatusCd": "APPROVED",
            "authStatusUpdateDate": null,
            "bandDtlId": null,
            "blockedLeaveCandidate": "NA",
            "certificationAuthFlag": true,
            "childEventTypeCd": null,
            "comments": null,
            "conditionStartDate": null,
            "confirmedDate": null,
            "consumedByAgreement": null,
            "createdBy": "ZANC_ZBEN_SUPER_USER",
            "creationDate": "2018-08-13T09:33:49.754+00:00",
            "diseaseCode": null,
            "duration": 3,
            "employeeShiftFlag": false,
            "endDate": "2018-05-10",
            "endDateDuration": null,
            "endDateTime": "2018-05-10T17:00:00+00:00",
            "endTime": "17:00",
            "establishmentDate": null,
            "frequency": null,
            "initialReportById": null,
            "initialTimelyNotifyFlag": false,
            "lastUpdateDate": "2018-08-13T09:34:20.220+00:00",
            "lastUpdateLogin": "734D4ABA7C277F08E05333D6F00AEAA9",
            "lastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
            "lateNotifyFlag": false,
            "legalEntityId": 100000011627095,
            "legislationCode": "US",
            "legislativeDataGroupId": 100010027007980,
            "notificationDate": "2018-08-13",
            "objectVersionNumber": 1,
            "openEndedFlag": false,
            "overridden": "N",
            "personAbsenceEntryId": 300100159604142,
            "periodOfIncapToWorkFlag": false,
            "periodOfServiceId": 300100032400494,
            "personId": 300100032399551,
            "plannedEndDate": null,
            "processingStatus": "P",
            "projectId": null,
            "singleDayFlag": false,
            "source": "ANC",
            "splCondition": null,
            "startDate": "2018-05-08",
            "startDateDuration": null,
            "startDateTime": "2018-05-08T08:00:00+00:00",
            "startTime": "08:00",
            "submittedDate": "2018-08-13",
            "timelinessOverrideDate": null,
            "unitOfMeasure": "D",
            "userMode": "ADMIN",
            "personNumber": null,
            "absenceType": null,
            "employer": null,
            "absenceReason": null,
            "absenceDispStatus": null,
            "dataSecurityPersonId": 300100032399551,
            "effectiveEndDate": "4712-12-31",
            "effectiveStartDate": "2008-01-01",
            "ObjectVersionNumber": 1,
            "agreementName": null,
            "paymentDetail": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142",
                    "name": "absences",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142",
                    "name": "absences",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/ApprovalStatusVA",
                    "name": "ApprovalStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/PersonVA",
                    "name": "PersonVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/ChildEventTypeVA",
                    "name": "ChildEventTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/BlockedLeaveCandidateVA",
                    "name": "BlockedLeaveCandidateVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/AbsenceAgreementBandDtlsVA",
                    "name": "AbsenceAgreementBandDtlsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/AbsenceDisplayStatusVA",
                    "name": "AbsenceDisplayStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/UomMeaningVA",
                    "name": "UomMeaningVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/AbsenceStatusVA",
                    "name": "AbsenceStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/SplConditionVA",
                    "name": "SplConditionVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/AbsenceTypeAgreementsVA",
                    "name": "AbsenceTypeAgreementsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/AbsenceTypeReasonsVA",
                    "name": "AbsenceTypeReasonsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/lov/AbsenceTypeVA",
                    "name": "AbsenceTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/child/absenceRecordingsDDF",
                    "name": "absenceRecordingsDDF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/child/absenceRecordingDFF",
                    "name": "absenceRecordingDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/child/absenceMaternity",
                    "name": "absenceMaternity",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159604142/child/absenceEntitlements",
                    "name": "absenceEntitlements",
                    "kind": "collection"
                }
            ]
        },
        {
            "absenceCaseId": null,
            "absenceEntryBasicFlag": true,
            "absencePatternCd": "GENERIC",
            "absenceStatusCd": "SUBMITTED",
            "absenceTypeId": 300100036660807,
            "absenceTypeReasonId": null,
            "agreementId": null,
            "approvalStatusCd": "APPROVED",
            "authStatusUpdateDate": null,
            "bandDtlId": null,
            "blockedLeaveCandidate": null,
            "certificationAuthFlag": null,
            "childEventTypeCd": null,
            "comments": null,
            "conditionStartDate": null,
            "confirmedDate": null,
            "consumedByAgreement": null,
            "createdBy": "ZANC_ZBEN_SUPER_USER",
            "creationDate": "2018-08-13T08:23:17+00:00",
            "diseaseCode": null,
            "duration": 5,
            "employeeShiftFlag": false,
            "endDate": "2018-11-30",
            "endDateDuration": null,
            "endDateTime": "2018-11-30T17:00:00+00:00",
            "endTime": "17:00",
            "establishmentDate": null,
            "frequency": null,
            "initialReportById": null,
            "initialTimelyNotifyFlag": null,
            "lastUpdateDate": "2018-08-13T08:27:33.180+00:00",
            "lastUpdateLogin": "7349341640754B5CE05333D6F00A322B",
            "lastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
            "lateNotifyFlag": null,
            "legalEntityId": 100000011627095,
            "legislationCode": "US",
            "legislativeDataGroupId": 100010027007980,
            "notificationDate": null,
            "objectVersionNumber": 3,
            "openEndedFlag": false,
            "overridden": "N",
            "personAbsenceEntryId": 300100159592743,
            "periodOfIncapToWorkFlag": null,
            "periodOfServiceId": 300100032404496,
            "personId": 300100032404256,
            "plannedEndDate": null,
            "processingStatus": "P",
            "projectId": null,
            "singleDayFlag": false,
            "source": "REST",
            "splCondition": null,
            "startDate": "2018-11-26",
            "startDateDuration": null,
            "startDateTime": "2018-11-26T08:00:00+00:00",
            "startTime": "08:00",
            "submittedDate": "2018-08-13",
            "timelinessOverrideDate": null,
            "unitOfMeasure": "D",
            "userMode": "MGR",
            "personNumber": null,
            "absenceType": null,
            "employer": null,
            "absenceReason": null,
            "absenceDispStatus": null,
            "dataSecurityPersonId": 300100032404256,
            "effectiveEndDate": "4712-12-31",
            "effectiveStartDate": "2008-01-01",
            "ObjectVersionNumber": 3,
            "agreementName": null,
            "paymentDetail": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
                    "name": "absences",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743",
                    "name": "absences",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ApprovalStatusVA",
                    "name": "ApprovalStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/PersonVA",
                    "name": "PersonVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/ChildEventTypeVA",
                    "name": "ChildEventTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/BlockedLeaveCandidateVA",
                    "name": "BlockedLeaveCandidateVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceAgreementBandDtlsVA",
                    "name": "AbsenceAgreementBandDtlsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceDisplayStatusVA",
                    "name": "AbsenceDisplayStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/UomMeaningVA",
                    "name": "UomMeaningVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceStatusVA",
                    "name": "AbsenceStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/SplConditionVA",
                    "name": "SplConditionVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeAgreementsVA",
                    "name": "AbsenceTypeAgreementsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeReasonsVA",
                    "name": "AbsenceTypeReasonsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/lov/AbsenceTypeVA",
                    "name": "AbsenceTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingsDDF",
                    "name": "absenceRecordingsDDF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceRecordingDFF",
                    "name": "absenceRecordingDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceMaternity",
                    "name": "absenceMaternity",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159592743/child/absenceEntitlements",
                    "name": "absenceEntitlements",
                    "kind": "collection"
                }
            ]
        },
        {
            "absenceCaseId": null,
            "absenceEntryBasicFlag": true,
            "absencePatternCd": "GENERIC",
            "absenceStatusCd": "SUBMITTED",
            "absenceTypeId": 300100036660807,
            "absenceTypeReasonId": null,
            "agreementId": null,
            "approvalStatusCd": "APPROVED",
            "authStatusUpdateDate": null,
            "bandDtlId": null,
            "blockedLeaveCandidate": "NA",
            "certificationAuthFlag": true,
            "childEventTypeCd": null,
            "comments": null,
            "conditionStartDate": null,
            "confirmedDate": null,
            "consumedByAgreement": null,
            "createdBy": "ZANC_ZBEN_SUPER_USER",
            "creationDate": "2018-08-13T09:31:23.441+00:00",
            "diseaseCode": null,
            "duration": 3,
            "employeeShiftFlag": false,
            "endDate": "2018-08-03",
            "endDateDuration": null,
            "endDateTime": "2018-08-03T17:00:00+00:00",
            "endTime": "17:00",
            "establishmentDate": null,
            "frequency": null,
            "initialReportById": null,
            "initialTimelyNotifyFlag": false,
            "lastUpdateDate": "2018-08-13T09:34:20.519+00:00",
            "lastUpdateLogin": "734D4ABA7C277F08E05333D6F00AEAA9",
            "lastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
            "lateNotifyFlag": false,
            "legalEntityId": 100000011627095,
            "legislationCode": "US",
            "legislativeDataGroupId": 100010027007980,
            "notificationDate": "2018-08-13",
            "objectVersionNumber": 2,
            "openEndedFlag": false,
            "overridden": "N",
            "personAbsenceEntryId": 300100159603857,
            "periodOfIncapToWorkFlag": false,
            "periodOfServiceId": 300100032400494,
            "personId": 300100032399551,
            "plannedEndDate": null,
            "processingStatus": "P",
            "projectId": null,
            "singleDayFlag": false,
            "source": "ANC",
            "splCondition": null,
            "startDate": "2018-08-01",
            "startDateDuration": null,
            "startDateTime": "2018-08-01T08:00:00+00:00",
            "startTime": "08:00",
            "submittedDate": "2018-08-13",
            "timelinessOverrideDate": null,
            "unitOfMeasure": "D",
            "userMode": "ADMIN",
            "personNumber": null,
            "absenceType": null,
            "employer": null,
            "absenceReason": null,
            "absenceDispStatus": null,
            "dataSecurityPersonId": 300100032399551,
            "effectiveEndDate": "4712-12-31",
            "effectiveStartDate": "2008-01-01",
            "ObjectVersionNumber": 2,
            "agreementName": null,
            "paymentDetail": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857",
                    "name": "absences",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857",
                    "name": "absences",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/ApprovalStatusVA",
                    "name": "ApprovalStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/PersonVA",
                    "name": "PersonVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/ChildEventTypeVA",
                    "name": "ChildEventTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/BlockedLeaveCandidateVA",
                    "name": "BlockedLeaveCandidateVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/AbsenceAgreementBandDtlsVA",
                    "name": "AbsenceAgreementBandDtlsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/AbsenceDisplayStatusVA",
                    "name": "AbsenceDisplayStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/UomMeaningVA",
                    "name": "UomMeaningVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/AbsenceStatusVA",
                    "name": "AbsenceStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/SplConditionVA",
                    "name": "SplConditionVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/AbsenceTypeAgreementsVA",
                    "name": "AbsenceTypeAgreementsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/AbsenceTypeReasonsVA",
                    "name": "AbsenceTypeReasonsVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/lov/AbsenceTypeVA",
                    "name": "AbsenceTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/child/absenceRecordingsDDF",
                    "name": "absenceRecordingsDDF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/child/absenceRecordingDFF",
                    "name": "absenceRecordingDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/child/absenceMaternity",
                    "name": "absenceMaternity",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences/300100159603857/child/absenceEntitlements",
                    "name": "absenceEntitlements",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences",
            "name": "absences",
            "kind": "collection"
        }
    ]
}