ROrossum
Workflow Run

List workflow runs

Changed on

Retrieve all workflow run objects.

get/api/v1/workflow_runs

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

annotationinteger[]

Annotation ID(s) filter

current_stepinteger

ID of the current workflow step to filter by

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

Status of the workflow run to filter by

ordering'id' | '-id'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "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 property 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 property allOf list for the response status