Skip to main content

DELETE /api/v1/jobs-management/schedules/{id}

Use this method to cancel a scheduled job that is in the Pending state.

Note
This REST API requires Lenovo XClarity Orchestrator v2.1 or later.

Authentication

Authentication with username and password is required.

Resource URI

DELETE https://{orchestrator_server_IP}/api/v1/jobs-management/schedules/{id}

where {id} is the ID of the scheduled job. To obtain the scheduled job ID, use GET /api/v1/jobs-management/schedules.

Query parameters

Done

Request body

Done

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
404Not foundThe resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDescription
{message_attributes}variesStatus messages (see Status messages)