ROrossum
Workflow Activity

List workflow activities

Changed on

Retrieve all workflow activity objects.

get/api/v1/workflow_activities

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

workflow_runinteger

ID of a workflow run to filter workflow activities by

created_at_beforestring date-time

Created before filter.

created_at_afterstring date-time

Created after filter.

assigneesinteger

ID of a user to filter workflow activities by assignees

action'step_started' | 'step_completed' | 'approved' | 'rejected' | 'workflow_started' | 'workflow_completed' | 'reassigned'

Filter workflow activities by action type

ordering'id' | '-id'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 7540,
      "url": "https://example.rossum.app/api/v1/workflow_activities/7540",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "annotation": "https://example.rossum.app/api/v1/annotations/314159",
      "workflow": "https://example.rossum.app/api/v1/workflows/7540",
      "workflow_step": "https://example.rossum.app/api/v1/workflow_steps/7540",
      "workflow_run": "https://example.rossum.app/api/v1/workflow_runs/7512",
      "assignees": [
        "https://example.rossum.app/api/v1/users/1",
        "https://example.rossum.app/api/v1/users/2"
      ],
      "action": "step_started",
      "note": "The workflow step started",
      "created_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status