Get document workflows

GET 
/documents/:documentId/workflows

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

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site 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

workflows

object[]

List of Document Workflows

Array [

workflowId string

Workflow identifier

name string

Workflow name

description string

Workflow description

currentStepId string

The current step workflow is on

status DocumentWorkflowStatus (string)

Status of the Workflow Document

Possible values: [COMPLETE, IN_PROGRESS, FAILED]

insertedDate string

Inserted Timestamp

]

next string

Example (from schema)

{
  "workflows": [
    {
      "workflowId": "string",
      "name": "string",
      "description": "string",
      "currentStepId": "string",
      "status": "COMPLETE",
      "insertedDate": "string"
    }
  ],
  "next": "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...