ROrossum
Workflow Run

Retrieve workflow run

Changed on

Get a workflow run object.

get/api/v1/workflow_runs/{workflowRunID}

Request

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

  • f1b5a910991dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status