Sign in
Workflow Step

Retrieve workflow step

Get a workflow step object.

get/api/v1/workflow_steps/{workflowStepID}

Path parameters

workflowStepIDinteger required

A unique integer value identifying this workflow step.

Response

OK

idinteger required

ID of the workflow step

namestring required

Name of the workflow step

urlstring uri required

URL of the workflow step

organizationstring uri required

Organization URL.

workflowstring uri required

URL of the workflow

conditionobject required

Condition that designates whether the workflow step will be entered

type'approval' required

Type of the workflow step (currently the only supported value is approval)

mode'any' | 'all' | 'auto' required

Supported values:

  • any - approval of one assignee is enough
  • all - all assignees must approve
  • auto - automatically approved if the condition matches
orderinginteger required

Designates the evaluation order of steps within a workflow (must be unique per a workflow)

Example response

{
  "id": 7540,
  "name": "Team Lead approval step",
  "url": "https://example.rossum.app/api/v1/workflow_steps/7540",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "workflow": "https://example.rossum.app/api/v1/workflows/7540",
  "condition": {},
  "type": "approval",
  "mode": "all",
  "ordering": 1
}

Changes

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