Sign in to run requests with your own sandbox key. Sign in

BatchExecutionRow

Subset of Execution fields surfaced when listing the children of a batch. Tokens with `executions:read:full` additionally receive `applicant_name` and `applicant_email`.

Type: BatchExecutionRow

BatchExecutionRow has 15 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 1 operation, listed under Used by. The machine-readable definition is #/components/schemas/BatchExecutionRow in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • id integer
  • object string
  • batch_execution_id integer
  • workflow_id integer
  • row_index integer 0-based position in the submitted `rows` array.
  • status string Lifecycle of an execution. `queued` (batch rows not yet dispatched), `pending`, `running` and `waiting` (paused on a Wait node or adverse-action waiting period) are in flight; `awaiting_review` is paused on human review; `completed`, `failed`, `cancelled` and `skipped` are terminal. One of queued pending running waiting awaiting_review completed failed cancelled skipped
  • retry_count integer
  • external_reference string, nullable
  • needs_human_review boolean
  • review_status string One of none in_review approved denied
  • started_at string (date-time), nullable
  • completed_at string (date-time), nullable
  • created_at string (date-time)
  • applicant_name string, nullable Only with `executions:read:full`.
  • applicant_email string, nullable Only with `executions:read:full`.

Used by

Was this page helpful?