Create an absence record
post
/hcmRestApi/resources/11.13.18.05/absences
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
absenceAttachments: array
Absence Attachments
Title:
Absence Attachments
The attachments resource is a child of the absences resource. It provides attachments of an absence record for a person. -
absenceCaseId: integer
(int64)
Unique identifier for the absence case.
-
absenceDispStatus: string
Absence processing status displayed to the user. Valid values are defined in the lookup ANC_PER_ABS_ENT_DISPLAY_STATUS.
-
absenceEntitlements: array
Absence Entitlements
Title:
Absence Entitlements
The absenceEntitlements resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence. -
absenceEntryBasicFlag: boolean
Title:
Basic Mode Indicator
Maximum Length:30
Default Value:false
Indicates whether the absence is recorded in basic mode or advanced mode. The default value is true. -
absenceMaternity: array
Absence Maternity Details
Title:
Absence Maternity Details
The absenceMaternity resource is a child of the absences resource. It provides details of maternity attributes when absence type is maternity. -
absencePatternCd: string
Maximum Length:
20
Unique code assigned to the absence pattern associated with an absence type. For example, absence pattern can be Generic for a vacation absence, Illness or injury for a sickness absence. -
absenceReason: string
Title:
Reason
Reason for absence attached to the absence type. -
absenceRecordingDFF: array
Absence Descriptive Flexfields
Title:
Absence Descriptive Flexfields
The absenceRecordingDFF resource provides descriptive flexfields associated with the absence entry. -
absenceRecordingsDDF: array
Absence Developer Descriptive Flexfields
Title:
Absence Developer Descriptive Flexfields
The absenceRecordingsDDF resource provides developer descriptive flexfields associated with the absence entry. -
absenceStatusCd: string
Title:
Status
Maximum Length:30
Default Value:'SUBMITTED'
Absence status, such as submitted, withdrawn. -
absenceType: string
Unique identifier for the absence type.
-
absenceTypeId(required): integer
(int64)
Title:
Absence Type
Unique identifier for the absence type. -
absenceTypeReasonId: integer
(int64)
Title:
Reason
Unique identifier for the absence reason. -
agreementId: integer
(int64)
Title:
Agreement Name
Unique identifier for the agreement name used to record absence. -
agreementName: string
Name of the agreement used to record absence.
-
approvalStatusCd: string
Title:
Approval Status
Maximum Length:30
Approval notification status of the recorded absence. -
assignmentId: integer
(int64)
Unique identifier of the assignment for which the absence is recorded. When an employee has multiple active assignments, this attribute can be used to restrict the absence to a specific assignment. You can't change the assignment when editing an existing absence.
-
authStatusUpdateDate: string
(date)
Title:
Status Last Updated
Latest updated date of the authorization status for the absence. -
bandDtlId: integer
(int64)
Title:
Payment Detail
Unique identifier for the payment details. -
blockedLeaveCandidate: string
Title:
Block Leave Status
Maximum Length:30
Determines whether the worker is eligible for block leave or not. Block leave enables workers to report a fixed period away from work. -
certificationAuthFlag: boolean
Title:
Authorized absence
Maximum Length:30
Provides notification for an authorized absence. -
childEventTypeCd: string
Maximum Length:
30
Unique code assigned for the child event. -
comments: string
Title:
Comments
Maximum Length:2000
Comments provided while recording the absence. -
conditionStartDate: string
(date)
Title:
Condition Start Date
Condition start date of an illness or injury leave. Used to indicate when the illness began or injury occurred, and could be different from the absence start date. -
confirmedDate: string
(date)
Title:
Confirmation Date
Confirmed start date of an absence. -
consumedByAgreement: string
Maximum Length:
30
Represents the agreement consumption condition of the absence. Possible values are Y, N, and null. The default value is null. -
diseaseCode: string
Title:
Disease Code
Maximum Length:250
Unique code assigned to a disease. -
duration: number
Title:
Duration
Duration of the recorded absence. -
employeeShiftFlag: boolean
Maximum Length:
20
Shift type of the employee's schedule. Possible values are time, duration and null. Default value is null. -
employer: string
Name of the employer.
-
endDate: string
(date)
Title:
End Date
End date of the recorded absence. -
endDateDuration: number
Title:
End Date Duration
Duration of the absence on the end date. This field allows the duration of the end date to be different than what is derived from the shift duration. -
endDateTime: string
(date-time)
Title:
End Date and Time
End date timestamp of an absence. -
endTime: string
Title:
End Time
Maximum Length:30
End time of the recorded absence. -
establishmentDate: string
(date)
Title:
Period of incapacity established
Date on which the period of incapacity began. This date refers to the date the employee could no longer work. -
frequency: string
Maximum Length:
30
Represents the frequency of the absence, such as weekly or monthly. -
initialReportById: integer
(int64)
Title:
Initially Reported By
Employee name who reported the notification. -
initialTimelyNotifyFlag: boolean
Title:
Late notification
Maximum Length:30
An absence notification qualified as a late notification. -
lateNotifyFlag: boolean
Title:
Late notification waived
Maximum Length:30
An absence notification that qualifies as a late notification and is waived. -
legalEntityId(required): integer
(int64)
Title:
Employer
Legal identifier for an employer. -
legislationCode: string
Maximum Length:
30
Legislation code of the employee for whom the absence is being entered. -
legislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group
Unique identifier which determines an employee's legislative data group. -
notificationDate: string
(date)
Title:
Submitted
Date the employee notifies the employer of an upcoming absence. -
objectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
openEndedFlag: boolean
Title:
Open ended leave
Maximum Length:1
Default Value:false
Indicates whether the absence is open-ended. Enables workers to submit an absence without entering an absence end date. The default value is false. -
overridden: string
Maximum Length:
10
Default Value:N
Indicates whether the absence duration has been overridden or not. The default value is false. -
paymentDetail: string
Name of payment detail of agreement used to record absence.
-
periodOfIncapToWorkFlag: boolean
Maximum Length:
30
Indicates whether an employee's period of incapacity to work has been established or not. The default value is false. -
periodOfServiceId: integer
(int64)
Unique identifier which determines an employee's period of service.
-
personAbsenceEntryId: integer
(int64)
Title:
Absence Entry ID
Unique identifier for the absence. -
personId(required): integer
(int64)
Unique identifier for the person.
-
personNumber: string
Unique person number for whom the absence is recorded.
-
plannedEndDate: string
(date)
Title:
Estimated End Date
Estimated end date used for the maternity absence. -
processingStatus: string
Maximum Length:
30
Processing status of the absence request, such as submitted, approved, declined. -
projectId: integer
(int64)
Unique project identifier.
-
singleDayFlag: boolean
Title:
Single day
Maximum Length:1
Default Value:false
Indicates whether the absence request is for a single day. Default value is false. -
source: string
Title:
Source
Maximum Length:10
Default Value:'REST'
Source of the absence imported from other applications. For example, an absence may be recorded via Absence Management, Time and Labor, a data loader or through the REST process. -
splCondition: string
Title:
Special Conditions
Maximum Length:1000
Special conditions for the absence. This is applicable when recording an absence using the Illness or injury or Childbirth pattern. -
startDate: string
(date)
Title:
Start Date
Start date of the recorded absence. -
startDateDuration: number
Title:
Start Date Duration
Duration of the absence on the start date. This field allows the duration of the start date to be different than what is derived from the shift duration. -
startDateTime: string
(date-time)
Title:
Start Date and Time
Start date timestamp of an absence. -
startTime: string
Title:
Start Time
Maximum Length:30
Start time of the recorded absence. -
submittedDate: string
(date)
Title:
Submitted
Date on which absence is created and submitted for approval. -
timelinessOverrideDate: string
(date)
Title:
Waiver Date
Date on which the late notification of the absence was waived. -
unitOfMeasure: string
Title:
UOM
Maximum Length:30
Unit of measure used to record the absence, such as days or hours. -
userMode: string
Maximum Length:
10
Default Value:EMP
Role of the user who entered this absence. Possible values are EMP, MGR or ADMIN.
Nested Schema : Absence Attachments
Type:
array
Title:
Absence Attachments
The attachments resource is a child of the absences resource. It provides attachments of an absence record for a person.
Show Source
Nested Schema : Absence Entitlements
Type:
array
Title:
Absence Entitlements
The absenceEntitlements resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence.
Show Source
Nested Schema : Absence Maternity Details
Type:
array
Title:
Absence Maternity Details
The absenceMaternity resource is a child of the absences resource. It provides details of maternity attributes when absence type is maternity.
Show Source
Nested Schema : Absence Descriptive Flexfields
Type:
array
Title:
Absence Descriptive Flexfields
The absenceRecordingDFF resource provides descriptive flexfields associated with the absence entry.
Show Source
Nested Schema : Absence Developer Descriptive Flexfields
Type:
array
Title:
Absence Developer Descriptive Flexfields
The absenceRecordingsDDF resource provides developer descriptive flexfields associated with the absence entry.
Show Source
Nested Schema : absences-absenceAttachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Surrogate identifier for the record. Applicable to existing records only. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name for the absence attachment type such as MISC. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type such as FILE, TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier for the document created in UCM directory. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder where the attachment is stored. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Status code of the error. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message that is displayed. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiry date of the absence record attachment. -
FileContents: string
(byte)
Title:
File Contents
Attribute for providing the file content. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached by the user. -
FileUrl: string
Title:
File Url
Relative path for downloading the attachment file. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of the content file uploaded such as plain/text, image/jpeg etc. -
UploadedFileLength: integer
Title:
File Size
Length of the content file uploaded. -
UploadedFileName: string
Title:
Uploaded File Name
Name of uploaded file. -
UploadedText: string
Title:
Uploaded Text
Text that is uploaded to the content repository. -
Uri: string
Title:
Uri
Maximum Length:4000
Uniform Resource Identifier of the uploaded file. -
Url: string
Title:
Url
Maximum Length:4000
Uniform Resource Identifier of the document attachment.
Nested Schema : absences-absenceEntitlements-item-post-request
Type:
Show Source
object
-
absenceEntitlementDetails: array
absenceEntitlementDetails
-
absencePlanName: string
Name of absence plan.
-
absencePlanUOMMeaning: string
Unit of measure used to record the absence, such as Days or Hours.
-
activityCdMeaning: string
Meaning of activity code for the entitlement summary record. For example, Qualified Entitlement, Entitlement exceeded.
-
assignmentId: integer
Unique assignment identifier for which entitlement is calculated.
-
assignmentName: string
Name of the assignment for which entitlement is calculated.
-
assignmentNumber: string
Unique number of the assignment for which entitlement is calculated.
-
changeReasonCdMeaning: string
Meaning of reason code for override of the payment percentage, such as Adjusted, Not specified.
-
entitlementMethodCd: string
Unique code for type of entitlement plan, such as 'Q'.
-
entitlementMethodCdMeaning: string
Meaning of entitlement method code for the plan, such as Qualification.
-
remaining: number
Remaining entitlement for the person for same assignment, plan and payment factor.
-
sourceCdMeaning: string
Meaning of source for entitlement. For example, Calculated entitlement, Payment percentage override.
-
used: number
Used entitlement for the person for same assignment, plan and payment factor.
Nested Schema : absences-absenceEntitlements-absenceEntitlementDetails-item-post-request
Type:
Show Source
object
-
absencePlanUOMMeaning: string
Meaning of code of unit of measure used to record the absence, such as Days or Hours.
Nested Schema : absences-absenceMaternity-item-post-request
Type:
Show Source
object
-
actualChildBirthDate: string
(date)
Title:
Actual Date of Childbirth
Actual date of childbirth or placement. -
actualDuration: number
Title:
Actual Duration
Actual duration of maternity leave. -
actualReturnDate: string
(date)
Title:
Actual End Date
Actual return date of maternity leave. -
actualStartDate: string
(date)
Title:
Actual Start Date
Actual start date of maternity leave. -
expectedDateOfChildBirth: string
(date)
Title:
Expected Date of Childbirth
Expected date of childbirth or placement. -
expectedEndDate: string
(date)
Title:
Estimated End Date
Expected end date of maternity leave. -
expectedWeekOfChildBirth: string
(date)
Expected week of maternity leave. This is Monday of the week in which the expected date of childbirth falls.
-
intendToWorkFlag: boolean
Title:
Won't return to work
Maximum Length:30
Indicates whether the absence can be submitted without a planned return date. Used for maternity absence only. The default value is true. -
leaveDuration: number
Title:
Planned Duration
Planned maternity leave duration. -
matchingDate: string
(date)
Title:
Placement Match Date
Date field to be used by localization team. -
openEndedFlag: boolean
Title:
Mark as open ended
Maximum Length:30
Indicates whether the absence can be submitted without an absence end date. The default value is false. -
personAbsenceEntryId: integer
(int64)
Unique identifier for the absence.
-
personAbsenceMaternityId: integer
(int64)
Unique identifier of a maternity record of absence.
-
plannedReturnDate: string
(date)
Title:
Planned End Date
Planned end date of maternity leave. -
plannedStartDate: string
(date)
Title:
Planned Start Date
Planned start date of maternity leave.
Nested Schema : absences-absenceRecordingDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield of an absence. Valid values are defined in the list LVVO___FLEX_Context. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
PerAbsenceEntryId: integer
(int64)
Unique identifier of an absence.
Nested Schema : absences-absenceRecordingsDDF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Developer descriptive flexfield of an absence. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Developer descriptive flexfield of an absence. -
PerAbsenceEntryId: integer
(int64)
Developer descriptive flexfield of an absence.
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 : absences-item-response
Type:
Show Source
object
-
absenceAttachments: array
Absence Attachments
Title:
Absence Attachments
The attachments resource is a child of the absences resource. It provides attachments of an absence record for a person. -
absenceCaseId: integer
(int64)
Unique identifier for the absence case.
-
absenceDispStatus: string
Absence processing status displayed to the user. Valid values are defined in the lookup ANC_PER_ABS_ENT_DISPLAY_STATUS.
-
absenceDispStatusMeaning: string
Read Only:
true
Maximum Length:255
Description of the absence transaction status. -
absenceEntitlements: array
Absence Entitlements
Title:
Absence Entitlements
The absenceEntitlements resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence. -
absenceEntryBasicFlag: boolean
Title:
Basic Mode Indicator
Maximum Length:30
Default Value:false
Indicates whether the absence is recorded in basic mode or advanced mode. The default value is true. -
absenceMaternity: array
Absence Maternity Details
Title:
Absence Maternity Details
The absenceMaternity resource is a child of the absences resource. It provides details of maternity attributes when absence type is maternity. -
absencePatternCd: string
Maximum Length:
20
Unique code assigned to the absence pattern associated with an absence type. For example, absence pattern can be Generic for a vacation absence, Illness or injury for a sickness absence. -
absenceReason: string
Title:
Reason
Reason for absence attached to the absence type. -
absenceRecordingDFF: array
Absence Descriptive Flexfields
Title:
Absence Descriptive Flexfields
The absenceRecordingDFF resource provides descriptive flexfields associated with the absence entry. -
absenceRecordingsDDF: array
Absence Developer Descriptive Flexfields
Title:
Absence Developer Descriptive Flexfields
The absenceRecordingsDDF resource provides developer descriptive flexfields associated with the absence entry. -
absenceStatusCd: string
Title:
Status
Maximum Length:30
Default Value:'SUBMITTED'
Absence status, such as submitted, withdrawn. -
absenceType: string
Unique identifier for the absence type.
-
absenceTypeId: integer
(int64)
Title:
Absence Type
Unique identifier for the absence type. -
absenceTypeReasonId: integer
(int64)
Title:
Reason
Unique identifier for the absence reason. -
absenceUpdatableFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the absence can be updated. If true, the absence can be updated. If false, the absence can't be updated. -
agreementId: integer
(int64)
Title:
Agreement Name
Unique identifier for the agreement name used to record absence. -
agreementName: string
Name of the agreement used to record absence.
-
allowAssignmentSelectionFlag: boolean
Read Only:
true
Indicates whether an assignment can be selected for the absence transaction. If true, an assignment can be selected and shown on the absence transaction. -
ApprovalDatetime: string
(date-time)
Read Only:
true
Date and time of the absence approval. -
approvalStatusCd: string
Title:
Approval Status
Maximum Length:30
Approval notification status of the recorded absence. -
assignmentId: integer
(int64)
Unique identifier of the assignment for which the absence is recorded. When an employee has multiple active assignments, this attribute can be used to restrict the absence to a specific assignment. You can't change the assignment when editing an existing absence.
-
assignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the worker's assignment. -
assignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Number of the worker's assignment. -
authStatusUpdateDate: string
(date)
Title:
Status Last Updated
Latest updated date of the authorization status for the absence. -
bandDtlId: integer
(int64)
Title:
Payment Detail
Unique identifier for the payment details. -
blockedLeaveCandidate: string
Title:
Block Leave Status
Maximum Length:30
Determines whether the worker is eligible for block leave or not. Block leave enables workers to report a fixed period away from work. -
certificationAuthFlag: boolean
Title:
Authorized absence
Maximum Length:30
Provides notification for an authorized absence. -
childEventTypeCd: string
Maximum Length:
30
Unique code assigned for the child event. -
comments: string
Title:
Comments
Maximum Length:2000
Comments provided while recording the absence. -
conditionStartDate: string
(date)
Title:
Condition Start Date
Condition start date of an illness or injury leave. Used to indicate when the illness began or injury occurred, and could be different from the absence start date. -
confirmedDate: string
(date)
Title:
Confirmation Date
Confirmed start date of an absence. -
consumedByAgreement: string
Maximum Length:
30
Represents the agreement consumption condition of the absence. Possible values are Y, N, and null. The default value is null. -
createdBy: string
Read Only:
true
Maximum Length:64
Name of the employee who created the absence record. -
creationDate: string
(date-time)
Read Only:
true
Date and time of the absence record creation. -
dataSecurityPersonId: integer
(int64)
Read Only:
true
Unique person identifier assigned to verify data security. -
diseaseCode: string
Title:
Disease Code
Maximum Length:250
Unique code assigned to a disease. -
duration: number
Title:
Duration
Duration of the recorded absence. -
effectiveEndDate: string
(date)
Read Only:
true
End date to check data security. -
effectiveStartDate: string
(date)
Read Only:
true
Start date to check data security. -
employeeShiftFlag: boolean
Maximum Length:
20
Shift type of the employee's schedule. Possible values are time, duration and null. Default value is null. -
employer: string
Name of the employer.
-
endDate: string
(date)
Title:
End Date
End date of the recorded absence. -
endDateDuration: number
Title:
End Date Duration
Duration of the absence on the end date. This field allows the duration of the end date to be different than what is derived from the shift duration. -
endDateTime: string
(date-time)
Title:
End Date and Time
End date timestamp of an absence. -
endTime: string
Title:
End Time
Maximum Length:30
End time of the recorded absence. -
establishmentDate: string
(date)
Title:
Period of incapacity established
Date on which the period of incapacity began. This date refers to the date the employee could no longer work. -
formattedDuration: string
Read Only:
true
Maximum Length:255
Duration of the recorded absence. -
frequency: string
Maximum Length:
30
Represents the frequency of the absence, such as weekly or monthly. -
initialReportById: integer
(int64)
Title:
Initially Reported By
Employee name who reported the notification. -
initialTimelyNotifyFlag: boolean
Title:
Late notification
Maximum Length:30
An absence notification qualified as a late notification. -
lastUpdateDate: string
(date-time)
Read Only:
true
Latest date and time the absence record was updated. -
lastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the employee who last updated the absence record. -
lastUpdateLogin: string
Read Only:
true
Maximum Length:32
User name of the employee who last updated the absence record. -
lateNotifyFlag: boolean
Title:
Late notification waived
Maximum Length:30
An absence notification that qualifies as a late notification and is waived. -
legalEntityId: integer
(int64)
Title:
Employer
Legal identifier for an employer. -
legislationCode: string
Maximum Length:
30
Legislation code of the employee for whom the absence is being entered. -
legislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group
Unique identifier which determines an employee's legislative data group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
notificationDate: string
(date)
Title:
Submitted
Date the employee notifies the employer of an upcoming absence. -
objectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ObjectVersionNumber: integer
(int32)
Read Only:
true
Number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
openEndedFlag: boolean
Title:
Open ended leave
Maximum Length:1
Default Value:false
Indicates whether the absence is open-ended. Enables workers to submit an absence without entering an absence end date. The default value is false. -
overridden: string
Maximum Length:
10
Default Value:N
Indicates whether the absence duration has been overridden or not. The default value is false. -
paymentDetail: string
Name of payment detail of agreement used to record absence.
-
periodOfIncapToWorkFlag: boolean
Maximum Length:
30
Indicates whether an employee's period of incapacity to work has been established or not. The default value is false. -
periodOfServiceId: integer
(int64)
Unique identifier which determines an employee's period of service.
-
personAbsenceEntryId: integer
(int64)
Title:
Absence Entry ID
Unique identifier for the absence. -
personId: integer
(int64)
Unique identifier for the person.
-
personNumber: string
Unique person number for whom the absence is recorded.
-
plannedEndDate: string
(date)
Title:
Estimated End Date
Estimated end date used for the maternity absence. -
processingStatus: string
Maximum Length:
30
Processing status of the absence request, such as submitted, approved, declined. -
projectId: integer
(int64)
Unique project identifier.
-
singleDayFlag: boolean
Title:
Single day
Maximum Length:1
Default Value:false
Indicates whether the absence request is for a single day. Default value is false. -
source: string
Title:
Source
Maximum Length:10
Default Value:'REST'
Source of the absence imported from other applications. For example, an absence may be recorded via Absence Management, Time and Labor, a data loader or through the REST process. -
splCondition: string
Title:
Special Conditions
Maximum Length:1000
Special conditions for the absence. This is applicable when recording an absence using the Illness or injury or Childbirth pattern. -
startDate: string
(date)
Title:
Start Date
Start date of the recorded absence. -
startDateDuration: number
Title:
Start Date Duration
Duration of the absence on the start date. This field allows the duration of the start date to be different than what is derived from the shift duration. -
startDateTime: string
(date-time)
Title:
Start Date and Time
Start date timestamp of an absence. -
startTime: string
Title:
Start Time
Maximum Length:30
Start time of the recorded absence. -
submittedDate: string
(date)
Title:
Submitted
Date on which absence is created and submitted for approval. -
timelinessOverrideDate: string
(date)
Title:
Waiver Date
Date on which the late notification of the absence was waived. -
unitOfMeasure: string
Title:
UOM
Maximum Length:30
Unit of measure used to record the absence, such as days or hours. -
unitOfMeasureMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the unit of measure used to record the absence, such as Days or Hours. -
userMode: string
Maximum Length:
10
Default Value:EMP
Role of the user who entered this absence. Possible values are EMP, MGR or ADMIN.
Nested Schema : Absence Attachments
Type:
array
Title:
Absence Attachments
The attachments resource is a child of the absences resource. It provides attachments of an absence record for a person.
Show Source
Nested Schema : Absence Entitlements
Type:
array
Title:
Absence Entitlements
The absenceEntitlements resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence.
Show Source
Nested Schema : Absence Maternity Details
Type:
array
Title:
Absence Maternity Details
The absenceMaternity resource is a child of the absences resource. It provides details of maternity attributes when absence type is maternity.
Show Source
Nested Schema : Absence Descriptive Flexfields
Type:
array
Title:
Absence Descriptive Flexfields
The absenceRecordingDFF resource provides descriptive flexfields associated with the absence entry.
Show Source
Nested Schema : Absence Developer Descriptive Flexfields
Type:
array
Title:
Absence Developer Descriptive Flexfields
The absenceRecordingsDDF resource provides developer descriptive flexfields associated with the absence entry.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absences-absenceAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Surrogate identifier for the record. Applicable to existing records only. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name for the absence attachment type such as MISC. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Name of the user who created the absence record attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the absence record attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the absence record attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type such as FILE, TEXT, or WEB_PAGE. -
DatatypeCodeMeaning: string
Read Only:
true
Meaning of DatatypeCode for the attachment type such as FILE, TEXT or URL. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier for the document created in UCM directory. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder where the attachment is stored. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Status code of the error. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message that is displayed. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiry date of the absence record attachment. -
FileContents: string
(byte)
Title:
File Contents
Attribute for providing the file content. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached by the user. -
FileUrl: string
Title:
File Url
Relative path for downloading the attachment file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image of the file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the document record attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the absence record attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the absence record attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of the content file uploaded such as plain/text, image/jpeg etc. -
UploadedFileLength: integer
Title:
File Size
Length of the content file uploaded. -
UploadedFileName: string
Title:
Uploaded File Name
Name of uploaded file. -
UploadedText: string
Title:
Uploaded Text
Text that is uploaded to the content repository. -
Uri: string
Title:
Uri
Maximum Length:4000
Uniform Resource Identifier of the uploaded file. -
Url: string
Title:
Url
Maximum Length:4000
Uniform Resource Identifier of the document attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Name of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : absences-absenceEntitlements-item-response
Type:
Show Source
object
-
absenceEntitlementDetails: array
Absence Entitlement Details
Title:
Absence Entitlement Details
The absenceEntitlementDetails resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence each day of the absence. -
absencePlanId: integer
(int64)
Read Only:
true
Unique identifier for the absence plan. -
absencePlanName: string
Name of absence plan.
-
absencePlanUOMMeaning: string
Unit of measure used to record the absence, such as Days or Hours.
-
activityCd: string
Read Only:
true
Maximum Length:255
Unique activity code for the entitlement summary record. For example, ORA_ANC_QUAL, ORA_ANC_EXCEED. -
activityCdMeaning: string
Meaning of activity code for the entitlement summary record. For example, Qualified Entitlement, Entitlement exceeded.
-
activityEndDate: string
(date-time)
Read Only:
true
End date of the entitlement record. -
activityStartDate: string
(date-time)
Read Only:
true
Start date of the entitlement record. -
assignmentId: integer
Unique assignment identifier for which entitlement is calculated.
-
assignmentName: string
Name of the assignment for which entitlement is calculated.
-
assignmentNumber: string
Unique number of the assignment for which entitlement is calculated.
-
calculationDate: string
(date-time)
Read Only:
true
Date of entitlement calculation. -
changeReasonCd: string
Read Only:
true
Maximum Length:255
Unique reason code for override of the payment percentage, such as ORA_AUTO_ADJ, ORA_NOT_SPEC. -
changeReasonCdMeaning: string
Meaning of reason code for override of the payment percentage, such as Adjusted, Not specified.
-
entitlementId: integer
(int64)
Read Only:
true
Unique identifier for each entitlement detail of the absence. -
entitlementMethodCd: string
Unique code for type of entitlement plan, such as 'Q'.
-
entitlementMethodCdMeaning: string
Meaning of entitlement method code for the plan, such as Qualification.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
payFactor: number
Read Only:
true
Payment percentage of the entitlement. -
personAbsenceEntryId: integer
(int64)
Read Only:
true
Unique identifier of the absence. -
personAbsenceTypeEntryId: integer
(int64)
Read Only:
true
Unique identifier for the absence type entry for each continuous absence. -
personId: integer
(int64)
Read Only:
true
Unique identifier for the person. -
planPeriodStartDate: string
(date-time)
Read Only:
true
Start date of the entitlement plan period. -
remaining: number
Remaining entitlement for the person for same assignment, plan and payment factor.
-
source: string
Read Only:
true
Maximum Length:255
Unique code for source of entitlement. For example, ORA_ANC_SYSTEM, ORA_ANC_PAY_PCT. -
sourceCdMeaning: string
Meaning of source for entitlement. For example, Calculated entitlement, Payment percentage override.
-
unitOfMeasure: string
Read Only:
true
Maximum Length:30
Unique code used to identify the unit of measure used to record the absence, such as D or H. -
units: number
Read Only:
true
Number of units used in this entitlement. -
used: number
Used entitlement for the person for same assignment, plan and payment factor.
Nested Schema : Absence Entitlement Details
Type:
array
Title:
Absence Entitlement Details
The absenceEntitlementDetails resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence each day of the absence.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absences-absenceEntitlements-absenceEntitlementDetails-item-response
Type:
Show Source
object
-
absencePlanUOMMeaning: string
Meaning of code of unit of measure used to record the absence, such as Days or Hours.
-
endDate: string
(date-time)
Read Only:
true
End date of absence entitlement details. -
entitlementDetailId: integer
(int64)
Read Only:
true
Unique identifier of the entitlement detail record. -
entitlementId: integer
(int64)
Read Only:
true
Unique identifier associated with this entitlement detail record. Foreign key to ANC_PER_ABS_PLN_SUMM_ENT. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
payFactor: number
Read Only:
true
Payment percentage of the entitlement. -
startDate: string
(date-time)
Read Only:
true
Start date of absence entitlement details. -
unitOfMeasure: string
Read Only:
true
Maximum Length:30
Unique code used to identify the unit of measure used to record the absence, such as D or H. -
units: number
Read Only:
true
Number of entitlement units used.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absences-absenceMaternity-item-response
Type:
Show Source
object
-
actualChildBirthDate: string
(date)
Title:
Actual Date of Childbirth
Actual date of childbirth or placement. -
actualDuration: number
Title:
Actual Duration
Actual duration of maternity leave. -
actualReturnDate: string
(date)
Title:
Actual End Date
Actual return date of maternity leave. -
actualStartDate: string
(date)
Title:
Actual Start Date
Actual start date of maternity leave. -
createdBy: string
Read Only:
true
Maximum Length:64
Name of the employee who created the maternity absence record. -
creationDate: string
(date-time)
Read Only:
true
Date and time of the maternity absence record creation. -
expectedDateOfChildBirth: string
(date)
Title:
Expected Date of Childbirth
Expected date of childbirth or placement. -
expectedEndDate: string
(date)
Title:
Estimated End Date
Expected end date of maternity leave. -
expectedWeekOfChildBirth: string
(date)
Expected week of maternity leave. This is Monday of the week in which the expected date of childbirth falls.
-
intendToWorkFlag: boolean
Title:
Won't return to work
Maximum Length:30
Indicates whether the absence can be submitted without a planned return date. Used for maternity absence only. The default value is true. -
lastUpdateDate: string
(date-time)
Read Only:
true
Latest date and time of the maternity absence record updation. -
lastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the employee who updated the maternity absence record most recently. -
lastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login identifier of employee who last updated the maternity record. -
leaveDuration: number
Title:
Planned Duration
Planned maternity leave duration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
matchingDate: string
(date)
Title:
Placement Match Date
Date field to be used by localization team. -
openEndedFlag: boolean
Title:
Mark as open ended
Maximum Length:30
Indicates whether the absence can be submitted without an absence end date. The default value is false. -
personAbsenceEntryId: integer
(int64)
Unique identifier for the absence.
-
personAbsenceMaternityId: integer
(int64)
Unique identifier of a maternity record of absence.
-
plannedReturnDate: string
(date)
Title:
Planned End Date
Planned end date of maternity leave. -
plannedStartDate: string
(date)
Title:
Planned Start Date
Planned start date of maternity leave.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absences-absenceRecordingDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield of an absence. Valid values are defined in the list LVVO___FLEX_Context. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerAbsenceEntryId: integer
(int64)
Unique identifier of an absence.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absences-absenceRecordingsDDF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Developer descriptive flexfield of an absence. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Developer descriptive flexfield of an absence. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerAbsenceEntryId: integer
(int64)
Developer descriptive flexfield of an absence.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- absenceAttachments
-
Parameters:
- absencesUniqID:
$request.path.absencesUniqID
The attachments resource is a child of the absences resource. It provides attachments of an absence record for a person. - absencesUniqID:
- absenceEntitlements
-
Parameters:
- absencesUniqID:
$request.path.absencesUniqID
The absenceEntitlements resource is a child of the absences resource. It provides a list of all the entitlements consumed by an absence. - absencesUniqID:
- absenceMaternity
-
Parameters:
- absencesUniqID:
$request.path.absencesUniqID
The absenceMaternity resource is a child of the absences resource. It provides details of maternity attributes when absence type is maternity. - absencesUniqID:
- absenceRecordingDFF
-
Parameters:
- absencesUniqID:
$request.path.absencesUniqID
The absenceRecordingDFF resource provides descriptive flexfields associated with the absence entry. - absencesUniqID:
- absenceRecordingsDDF
-
Parameters:
- absencesUniqID:
$request.path.absencesUniqID
The absenceRecordingsDDF resource provides developer descriptive flexfields associated with the absence entry. - absencesUniqID:
Examples
The following example shows how to create an absence 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> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/absences
Example of Payload
The following is an example of the payload.
{ "personNumber": "955160008182159", "employer": "Vision Corporation", "absenceType": " ANC_VISION_SICKNESS_TYPE2", "startDate": "2017-08-10", "startTime": "08:00", "endDate": "2017-08-10", "endTime": "17:00", "absenceStatusCd": "SUBMITTED" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 201 Created
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "absenceEntryBasicFlag": true, "absencePatternCd": "II", "absenceStatusCd": "SUBMITTED", "absenceTypeId": 300100037938175, "absenceTypeReasonId": null, "blockedLeaveCandidate": null, "comments": null, "conditionStartDate": null, "confirmedDate": null, "createdBy": "HCM_USER10", "creationDate": "2017-10-09T02:25:07-07:00", "duration": 1, "endDate": "2017-08-10", "endDateDuration": null, "endDateTime": "2017-08-10T17:00:00-07:00", "endTime": "17:00", "lastUpdateDate": "2017-10-09T02:26:21.244-07:00", "lastUpdateLogin": "5AE04B480C095BDCE0530703F00A5255", "lastUpdatedBy": "HCM_USER10", "lateNotifyFlag": null, "notificationDate": null, "objectVersionNumber": 2, "openEndedFlag": false, "overridden": "N", "personAbsenceEntryId": 300100116862835, "personId": 300100052398992, "singleDayFlag": true, "source": "REST", "startDate": "2017-08-10", "startDateDuration": null, "startDateTime": "2017-08-10T08:00:00-07:00", "startTime": "08:00", "submittedDate": "2017-10-09", "unitOfMeasure": "D", "userMode": "ADMIN", "personNumber": "955160008182159", "absenceType": " ANC_VISION_SICKNESS_TYPE2", "employer": "Vision Corporation", "absenceReason": null, "absenceDispStatus": null, "dataSecurityPersonId": 300100052398992, "effectiveStartDate": "2014-01-01", "effectiveEndDate": "4712-12-31", "links": [11] 0: {... ...} }