Delete Single Batch

Deletes a batch and all related jobs and job definitions. Optionally also deletes the batch history.

Method

DELETE /batch/{id}

Parameters

Path Parameters

Name Description
id The id of the batch to be deleted.

Query Parameters

Name Description
cascade true, if the historic batch and historic job logs for this batch should also be deleted.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
404 application/json Deployment with id 'aDeploymentId' does not exist. See the Introduction for the error response format.

Example

Request

Delete a batch with id aBatch and cascade deletion to history:

DELETE /batch/aBatch?cascade=true

Response

Status 204. No content.

On this Page: