Batch
Batch has 13 top-level fields.
Fields typed as another schema link to that schema's page, and nested objects expand in place below.
It is referenced by 7 operations, listed under Used by.
The machine-readable definition is #/components/schemas/Batch in
openapi.json;
the example in the right-hand rail is synthesized from the field examples in that spec.
Fields
-
idinteger -
objectstring -
workflow_idinteger -
statusstring `completed` means every row reached a terminal status, even when some rows failed (see `failed_count`). `failed` means the batch itself stopped on an unexpected error; it is not accepted by `filter[status]` on `listBatches`. One ofpendingrunninginterruptedcompletedcancelledfailed -
execution_modestring One oftestlive -
external_referencestring, nullable -
total_countinteger -
completed_countinteger -
failed_countinteger -
started_atstring (date-time), nullable -
completed_atstring (date-time), nullable -
created_atstring (date-time) -
updated_atstring (date-time)
Used by
-
POST
/workflows/{id}/batchesCreate a batch from N rows -
GET
/batchesList batches -
GET
/batches/{id}Show a batch -
GET
/batches/{id}/executionsList child executions of a batch -
POST
/batches/{id}/cancelCancel a batch -
POST
/batches/{id}/resumeResume an interrupted batch -
POST
/batches/{id}/retry_failedRetry failed and skipped rows