Get workflow

GET 
/workflows/:workflowId

Get a workflow; available as an Add-On Module

Request

Path Parameters

workflowId stringrequired

Workflow Identifier

Query Parameters

siteId string

Site Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

name string

Workflow name

description string

Workflow description

inUse boolean

Whether the Workflow is in use

status WorkflowStatus (string)

Status of the Workflow

Possible values: [ACTIVE, INACTIVE]

steps

object[]

Workflow steps

Array [

stepId string

Workflow Step Identifier

action

object

status DocumentActionStatus (string)

Status of the Document Action

Possible values: [COMPLETE, FAILED, IN_QUEUE, PENDING, RUNNING, SKIPPED, FAILED_RETRY]

type DocumentActionType (string)

Type of the Document Action

Possible values: [ANTIVIRUS, DOCUMENTTAGGING, FULLTEXT, NOTIFICATION, OCR, QUEUE, WEBHOOK, IDP, PUBLISH, PDFEXPORT, EVENTBRIDGE]

queueId string

Queue Id

workflowId string

Workflow Id

workflowStepId string

Workflow Step Id

message string

Action message information

userId string

User who requested the Action

insertedDate string

Inserted Timestamp

startDate string

Started Timestamp

completedDate string

Completed Timestamp

parameters

object

Action parameters

property name* string

metadata

object

Action metadata

property name* string

queue

object

queueId string

Queue Id

approvalGroups string[]

decisions

object[]

Workflow Decisions

Array [

type WorkflowStepDecisionType (string)

Type of Workflow Step Decision

Possible values: [APPROVE, REJECT]

nextStepId string

Workflow Step to move to

]

]

Example (from schema)

{
  "name": "string",
  "description": "string",
  "inUse": true,
  "status": "ACTIVE",
  "steps": [
    {
      "stepId": "string",
      "action": {
        "status": "COMPLETE",
        "type": "ANTIVIRUS",
        "queueId": "string",
        "workflowId": "string",
        "workflowStepId": "string",
        "message": "string",
        "userId": "string",
        "insertedDate": "string",
        "startDate": "string",
        "completedDate": "string",
        "parameters": {},
        "metadata": {}
      },
      "queue": {
        "queueId": "string",
        "approvalGroups": [
          "string"
        ]
      },
      "decisions": [
        {
          "type": "APPROVE",
          "nextStepId": "string"
        }
      ]
    }
  ]
}

Loading...