Oracle Enterprise Scheduling Service

Initiate a cancel operation for the job request

post

ess/rest/scheduler/v1/requests/{requestId}/cancel

Cancels the processing of a request that is not in a terminal state. For a singleton and child request in WAIT, READY, BLOCKED or HOLD state, this operation will cause them to go to CANCELLED state. For a singleton and child request in RUNNING or COMPLETED state, cancellation is best effort and the state will go to a transitory CANCELLING state which will persist until the request has been cancelled and transitions to CANCELLED or some other terminal state. For parent requests, this operation cascades to all its children.

Request

Path Parameters

requestId(required): integer(int64)

the job request ID

There's no request body for this operation.

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json

200 Response

Operation initiated

Root Schema : Links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href(required): string
rel(required): string

Allowed Values: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 Response

Unsupported state for operation

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

403 Response

Not authorized to cancel this request

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

404 Response

Request ID not found

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

409 Response

Conflict

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

500 Response

Scheduling sub-system error

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}