Jump to

• Request
• Response

Display absence type projected balance.

post

/hcmRestApi/resources/11.13.18.05/absences/action/loadProjectedBalance

Displays the projected absence type balance based on the absence type balance and absence transactions through the absence end date.

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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• entry: object entry
  Additional Properties Allowed: additionalProperties

  Projected balance of the absence type based on the absence request.
• entryDetails: array entryDetails
  Projected balance of the absence type based on the absence request in the daily details entry region.

{
    "type":"object",
    "properties":{
        "entry":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Projected balance of the absence type based on the absence request.",
            "nullable":true
        },
        "entryDetails":{
            "type":"array",
            "description":"Projected balance of the absence type based on the absence request in the daily details entry region.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : entry

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Projected balance of the absence type based on the absence request.",
    "nullable":true
}

Projected balance of the absence type based on the absence request.

Nested Schema : entryDetails

Type: array

Projected balance of the absence type based on the absence request in the daily details entry region.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Projected balance of the absence type based on the absence request in the daily details entry region.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Return projected balance of the absence type.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return projected balance of the absence type."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return projected balance of the absence type."
}

Return projected balance of the absence type.

Back to Top