REST API for Oracle Fusion Cloud HCM

Cancel a candidate interview in the recruiting agency

post

/hcmRestApi/resources/11.13.18.05/recruitingUIAgencyCandidateInterviews/action/cancelInterview

Cancels a candidate interview in the recruiting agency. This action updates the interview status and notifies relevant parties.

Request

Header Parameters

Metadata-Context: string

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: string

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: object

Show Source

interviewScheduleId: number

Interview schedule identifier when canceling a candidate interview in the recruiting agency.

{
    "type":"object",
    "properties":{
        "interviewScheduleId":{
            "type":"number",
            "description":"Interview schedule identifier when canceling a candidate interview in the recruiting agency.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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: object

Show Source

result(required): string

Returned value when canceling a candidate interview in the recruiting agency.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returned value when canceling a candidate interview in the recruiting agency."
        }
    },
    "additionalProperties":false
}