extractions

Cancel Batch

post/v1/batches/{batch_id}/cancel

Request

  • Base URL: https://api.caelario.com
  • URL: https://api.caelario.com/v1/batches/{batch_id}/cancel
  • Auth: none declared

Path parameters

batch_idstring required

Headers

X-API-Keystring nullable
X-Workspace-IDstring nullable
authorizationstring nullable

Response

Successful Response

idstring required
platformstring required
operationstring required
requested_limitinteger required
include_postsinteger
target_countinteger required
statusstring required
queued_countinteger required
running_countinteger required
completed_countinteger required
failed_countinteger required
cancelled_countinteger required
result_countinteger required
reserved_creditsinteger required
billed_creditsinteger required
cancel_requested_atstring date-time nullable required
created_atstring date-time required
idempotent_replayboolean

Changes

No recorded changes to this operation across all 1 revision of this API.