Jump to

• Request
• Response

Cancel a job offer

post

/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/offerCancelAction

Cancels a job offer.

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

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

Root Schema : schema

Type: object

Show Source

• comments: string
  Payload parameter to send the job comments when canceling a job offer.
• offerId: number
  Payload parameter to send the job offer ID when canceling a job offer.
• phaseId: number
  Payload parameter to send the job phase ID when canceling a job offer.
• reasonId: number
  Payload parameter to send the job reason ID when canceling a job offer.
• stateId: number
  Payload parameter to send the job state ID when canceling a job offer.
• submissionId: number
  Payload parameter to send the candidate application ID when canceling a job offer.

{
    "type":"object",
    "properties":{
        "submissionId":{
            "type":"number",
            "description":"Payload parameter to send the candidate application ID when canceling a job offer.",
            "nullable":true
        },
        "comments":{
            "type":"string",
            "description":"Payload parameter to send the job comments when canceling a job offer.",
            "nullable":true
        },
        "reasonId":{
            "type":"number",
            "description":"Payload parameter to send the job reason ID when canceling a job offer.",
            "nullable":true
        },
        "stateId":{
            "type":"number",
            "description":"Payload parameter to send the job state ID when canceling a job offer.",
            "nullable":true
        },
        "phaseId":{
            "type":"number",
            "description":"Payload parameter to send the job phase ID when canceling a job offer.",
            "nullable":true
        },
        "offerId":{
            "type":"number",
            "description":"Payload parameter to send the job offer ID when canceling a job offer.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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

  Response returned when canceling a job offer.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Response returned when canceling a job offer."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Response returned when canceling a job offer."
}

Response returned when canceling a job offer.

Back to Top