Sign in
Workflow Activity

Retrieve workflow activity

Get a workflow activity object.

get/api/v1/workflow_activities/{workflowActivityID}

Response

OK

idinteger required

ID of the workflow activity

urlstring uri required

URL of the workflow activity

organizationstring uri required

Organization URL.

annotationstring uri required

URL of the related annotation

workflowstring uri required

URL of the related workflow

workflow_stepstring uri required

URL of the related workflow step

workflow_runstring uri required

URL of the related workflow run

assigneesstring[] required

List of assigned users.

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

Supported values are: step_started, step_completed, approved, rejected, workflow_started, workflow_completed, reassigned

notestring required

String note of the activity

created_atstring date-time required

Date and time of when the activity was created

created_bystring uri nullable required

User who created the activity

Example response

{
  "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

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