Get document workflow

GET 
/documents/:documentId/workflows/:workflowId

Gets a document workflow; available as an Add-On Module

Request

Path Parameters

documentId stringrequired

Document Identifier

workflowId stringrequired

Workflow Identifier

Query Parameters

siteId string

Site Identifier

artifactId string

Artifact Document Identifier

Responses

200

200 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

workflow

object

workflowId string

Workflow identifier

name string

Workflow name

description string

Workflow description

currentStepId string

The current step workflow is on

actionCount integer

Number of actions added for the current workflow step

completedActionCount integer

Number of completed actions for the current workflow step

status DocumentWorkflowStatus (string)

Status of the Workflow Document

Possible values: [COMPLETE, IN_PROGRESS, FAILED]

insertedDate string

Inserted Timestamp

Example (from schema)

{
  "workflow": {
    "workflowId": "string",
    "name": "string",
    "description": "string",
    "currentStepId": "string",
    "actionCount": 0,
    "completedActionCount": 0,
    "status": "COMPLETE",
    "insertedDate": "string"
  }
}

400

400 BAD REQUEST

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...