Get an absence type balance
post
/hcmRestApi/resources/11.13.18.05/absences/action/getAbsenceTypeBalance
Provides the absence type balance for the selected absence type. This includes all absence plans associated with the selected absence type.
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
assignmentId: number
Balance of the absence type based on the assignment ID.
-
effectiveDate: string
Balance of the absence type based on the effective date.
-
personId: number
Balance of the absence type based on the person ID.
-
typeId: number
Balance of the absence type based on the type ID.
-
userContext: string
Balance of the absence type based on the user context or role.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesReturn balance of the absence type.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Return balance of the absence type.