Sign in
Workflow Run

Retrieve workflow run

Get a workflow run object.

get/api/v1/workflow_runs/{workflowRunID}

Path parameters

workflowRunIDinteger required

A unique integer value identifying this workflow run.

Response

OK

idinteger required

ID of the workflow run

urlstring uri required

URL of the workflow run

organizationstring uri required

Organization URL.

annotationstring uri required

URL of the annotation

current_stepstring uri required

URL of the workflow step

workflow_status'pending' | 'approved' | 'rejected' required

Status of the workflow run

Example response

{
  "id": 75402,
  "url": "https://example.rossum.app/api/v1/workflow_runs/7512",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "annotation": "https://example.rossum.app/api/v1/annotations/314159",
  "current_step": "https://example.rossum.app/api/v1/workflow_steps/7540",
  "workflow_status": "pending"
}

Changes

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