Sign in
Beta
Batch Processing

Cancel Batch Job

Cancel a running batch processing job.

Stops processing and marks pending items as cancelled. Items currently being processed may still complete.

post/api/v1/beta/batch-processing/{job_id}/cancel

Path parameters

job_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Headers

temporal-namespacestring nullable

Cookies

sessionstring nullable

Request body

reasonstring nullable

Optional reason for cancelling the job

Response

Successful Response

job_idstring required

ID of the cancelled job

status'pending' | 'running' | 'dispatched' | 'completed' | 'failed' | 'cancelled' required

Status of a batch processing job.

processed_itemsinteger required

Number of items processed before cancellation

messagestring required

Confirmation message

Changes

Changed in 1 of the 33 revisions of this API.2

  • b17341164de92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog