SHshipsecai
workflows

GET /api/v1/workflows/runs/{runId}

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/workflows/runs/{runId}
  • Auth
    none declared

Path parameters

runIdstring required

Response

Metadata for a single workflow run

idstring
workflowIdstring
organizationIdstring
status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'UNKNOWN'
startTimestring date-time
endTimestring date-time nullable
temporalRunIdstring nullable
workflowVersionIdstring nullable
workflowVersionnumber nullable
workflowNamestring
eventCountnumber
nodeCountnumber
durationnumber
triggerType'manual' | 'schedule' | 'api'
triggerSourcestring nullable
triggerLabelstring nullable

Changes

  • cc60562ad9f3Revision changes
    • info

      added the optional property to the response with the status

  • 08fb21a4dc5cRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status