Sign in
workflows

Run Workflow

Run a workflow by triggering a new job if none is currently active.

post/api/v1/workflows/{workflow_id}/run

Path parameters

string uuid required
OR
string required

Headers

unstructured-api-keystring nullable

Response

Successful Response

idstring uuid required
workflow_idstring uuid required
workflow_namestring required
status'SCHEDULED' | 'IN_PROGRESS' | 'COMPLETED' | 'STOPPED' | 'FAILED' | 'REJECTED' required
created_atstring date-time required
runtimestring duration nullable
input_file_idsstring[] nullable
job_type'ephemeral' | 'persistent' | 'scheduled' | 'template'
reasonstring nullable

Sanitized failure reason for a FAILED job; None otherwise.

Changes

Changed in 1 of the 3 revisions of this API.1

  • ccebd049e0121See the full diff
    • ○

      added the optional property reason to the response with the 202 status

      response-optional-property-added