Jump to

• Request
• Response

Perform a certificate action for an absence

post

/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryCertifications/action/performCertificateAction

Performs an action on the certificate such as Confirm, Void, Update Due Date, Update Expiration Date or Revise Dates.

Request

Path Parameters

• absencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Absences resource and used to uniquely identify an instance of Absences. The client should not generate the hash key value. Instead, the client should query on the Absences collection resource in order to navigate to a specific instance of Absences to get the hash key.

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

• action: string
  Name of the action performed on the certificate.
• certificationActionMap: object certificationActionMap
  Additional Properties Allowed: additionalProperties

  Variable that holds values required for certificate action.
• personCertificationId: number
  Unique identifier for the certificate attached to an absence.

{
    "type":"object",
    "properties":{
        "certificationActionMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Variable that holds values required for certificate action.",
            "nullable":true
        },
        "personCertificationId":{
            "type":"number",
            "description":"Unique identifier for the certificate attached to an absence.",
            "nullable":true
        },
        "action":{
            "type":"string",
            "description":"Name of the action performed on the certificate.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : certificationActionMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Variable that holds values required for certificate action.",
    "nullable":true
}

Variable that holds values required for certificate action.

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): string
  Return success or failure of the certificate action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Return success or failure of the certificate action."
        }
    },
    "additionalProperties":false
}

Back to Top