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

description string

Workflow Step description

action

object

status DocumentActionStatus (string)

Status of the Document Action

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

type DocumentActionType (string)

Type of the Document Action

Possible values: [ANTIVIRUS, DOCUMENTTAGGING, FULLTEXT, MOVE, DELETE, CHECKSUM, NOTIFICATION, OCR, QUEUE, WEBHOOK, IDP, PUBLISH, PDFEXPORT, EVENTBRIDGE, RESIZE, LLMPROMPT, DATA_CLASSIFICATION, MALWARE_SCAN]

retryCount number

The number of times this action has already been attempted

maxRetries number

The maximum number of retry attempts allowed for this action

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

metadata

object

Action metadata

property name* string

queue

object

queueId string

Queue Id

approvalGroups string[]

mappings

object[]

Array [

mappingId stringrequired

Mapping Identifier

]

decision

object

conditions

object[]

Workflow Step Conditions

Array [

all

object[]

Workflow Step Condition Criteria

Array [

source

object

required

Defines the document-derived source value to evaluate for a workflow condition criterion.

The source identifies where the value comes from before applying the operator. Supported sources include:

• a document attribute identified by attributeKey

• a comparison between a document attribute value and another attribute-derived value

• the document content type

• the document path

oneOf

WorkflowStepConditionDocumentAttribute

Uses a document attribute as the source value for a workflow condition criterion.

The attribute is selected using attributeKey.

attributeKey stringrequired

Document attribute key

WorkflowStepConditionAttributeValueComparison

Compares the value of one document attribute to another attribute-derived value on the same document.

The criterion operator is evaluated as: document.attribute[valueAttributeKey] OP comparison

Literal comparison value fields are not used with this source.

sourceType WorkflowStepConditionAttributeValueComparisonSourceType (string)required

Identifies this source as an attribute-value comparison.

Possible values: [DOCUMENT_ATTRIBUTE_VALUE_COMPARISON]

valueAttributeKey stringrequired

Document attribute key containing the value to compare.

comparison

object

required

Defines the right-side comparison value for an attribute value comparison.

oneOf

WorkflowStepConditionAttributeValueComparisonAttribute

Uses another document attribute value as the right-side comparison value.

attributeKey stringrequired

Document attribute key containing the comparison value.

WorkflowStepConditionAttributeValueComparisonAggregate

Uses an aggregate over another document attribute's values as the right-side comparison value.

attributeKey stringrequired

Document attribute key whose values are aggregated for comparison.

aggregateType WorkflowStepConditionAttributeAggregateType (string)required

Aggregate operation applied to document attribute values.

Values:

• FIRST - First value for the attribute
• LAST - Last value for the attribute
• SUM - Sum of numeric values for the attribute
• MIN - Minimum numeric value for the attribute
• MAX - Maximum numeric value for the attribute
• COUNT - Count of values for the attribute

Possible values: [FIRST, LAST, SUM, MIN, MAX, COUNT]

WorkflowStepConditionDocumentStandardMetadata

Identifies the built-in document metadata field to evaluate for a workflow condition criterion.

Values:

• PATH - Evaluate the document path

• CONTENT_TYPE - Evaluate the document content type

string

Possible values: [PATH, CONTENT_TYPE]

operator WorkflowStepConditionOperator (string)required

Comparison operator used to evaluate a workflow condition criterion.

Values:

• EQ - Equals
• NEQ - Not equals
• CONTAINS - Contains substring or matching value
• NOT_CONTAINS - Does not contain substring or matching value
• STARTS_WITH - Starts with value
• ENDS_WITH - Ends with value
• GT - Greater than
• GTE - Greater than or equal
• LT - Less than
• LTE - Less than or equal
• EXISTS - Field exists
• NOT_EXISTS - Field does not exist
• IN - Matches one of the provided values
• NOT_IN - Does not match any of the provided values
• IS_EMPTY - Source value is empty
• IS_NOT_EMPTY - Source value is not empty

Possible values: [EQ, NEQ, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GT, GTE, LT, LTE, EXISTS, NOT_EXISTS, IN, NOT_IN, IS_EMPTY, IS_NOT_EMPTY]

stringValue string

String comparison value

numberValue number

Numeric comparison value

booleanValue boolean

Boolean comparison value

stringValues string[]

String values used for IN or NOT_IN comparisons

]

any

object[]

Workflow Step Condition Criteria

Array [

source

object

required

Defines the document-derived source value to evaluate for a workflow condition criterion.

The source identifies where the value comes from before applying the operator. Supported sources include:

• a document attribute identified by attributeKey

• a comparison between a document attribute value and another attribute-derived value

• the document content type

• the document path

oneOf

WorkflowStepConditionDocumentAttribute

Uses a document attribute as the source value for a workflow condition criterion.

The attribute is selected using attributeKey.

attributeKey stringrequired

Document attribute key

WorkflowStepConditionAttributeValueComparison

Compares the value of one document attribute to another attribute-derived value on the same document.

The criterion operator is evaluated as: document.attribute[valueAttributeKey] OP comparison

Literal comparison value fields are not used with this source.

sourceType WorkflowStepConditionAttributeValueComparisonSourceType (string)required

Identifies this source as an attribute-value comparison.

Possible values: [DOCUMENT_ATTRIBUTE_VALUE_COMPARISON]

valueAttributeKey stringrequired

Document attribute key containing the value to compare.

comparison

object

required

Defines the right-side comparison value for an attribute value comparison.

oneOf

WorkflowStepConditionAttributeValueComparisonAttribute

Uses another document attribute value as the right-side comparison value.

attributeKey stringrequired

Document attribute key containing the comparison value.

WorkflowStepConditionAttributeValueComparisonAggregate

Uses an aggregate over another document attribute's values as the right-side comparison value.

attributeKey stringrequired

Document attribute key whose values are aggregated for comparison.

aggregateType WorkflowStepConditionAttributeAggregateType (string)required

Aggregate operation applied to document attribute values.

Values:

• FIRST - First value for the attribute
• LAST - Last value for the attribute
• SUM - Sum of numeric values for the attribute
• MIN - Minimum numeric value for the attribute
• MAX - Maximum numeric value for the attribute
• COUNT - Count of values for the attribute

Possible values: [FIRST, LAST, SUM, MIN, MAX, COUNT]

WorkflowStepConditionDocumentStandardMetadata

Identifies the built-in document metadata field to evaluate for a workflow condition criterion.

Values:

• PATH - Evaluate the document path

• CONTENT_TYPE - Evaluate the document content type

string

Possible values: [PATH, CONTENT_TYPE]

operator WorkflowStepConditionOperator (string)required

Comparison operator used to evaluate a workflow condition criterion.

Values:

• EQ - Equals
• NEQ - Not equals
• CONTAINS - Contains substring or matching value
• NOT_CONTAINS - Does not contain substring or matching value
• STARTS_WITH - Starts with value
• ENDS_WITH - Ends with value
• GT - Greater than
• GTE - Greater than or equal
• LT - Less than
• LTE - Less than or equal
• EXISTS - Field exists
• NOT_EXISTS - Field does not exist
• IN - Matches one of the provided values
• NOT_IN - Does not match any of the provided values
• IS_EMPTY - Source value is empty
• IS_NOT_EMPTY - Source value is not empty

Possible values: [EQ, NEQ, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GT, GTE, LT, LTE, EXISTS, NOT_EXISTS, IN, NOT_IN, IS_EMPTY, IS_NOT_EMPTY]

stringValue string

String comparison value

numberValue number

Numeric comparison value

booleanValue boolean

Boolean comparison value

stringValues string[]

String values used for IN or NOT_IN comparisons

]

transition

object

required

type WorkflowStepTransitionType (string)required

Defines the outcome of a workflow step transition.

A transition determines what happens after a workflow step finishes evaluating its conditions, decisions, or actions.

Depending on the transition type, the workflow may:

• Move to another workflow step
• Complete successfully
• Be rejected
• Be cancelled
• Remain on the current step

Some transition types require additional properties. For example, when the type is STEP, a target step identifier must be provided in the transition object.

Possible values: [STEP, RETRY, COMPLETE]

stepId string

Target workflow step

]

defaultTransition

object

type WorkflowStepTransitionType (string)required

Defines the outcome of a workflow step transition.

A transition determines what happens after a workflow step finishes evaluating its conditions, decisions, or actions.

Depending on the transition type, the workflow may:

• Move to another workflow step
• Complete successfully
• Be rejected
• Be cancelled
• Remain on the current step

Some transition types require additional properties. For example, when the type is STEP, a target step identifier must be provided in the transition object.

Possible values: [STEP, RETRY, COMPLETE]

stepId string

Target workflow step

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",
      "description": "string",
      "action": {
        "status": "COMPLETE",
        "type": "ANTIVIRUS",
        "retryCount": 0,
        "maxRetries": 0,
        "queueId": "string",
        "workflowId": "string",
        "workflowStepId": "string",
        "message": "string",
        "userId": "string",
        "insertedDate": "string",
        "startDate": "string",
        "completedDate": "string",
        "parameters": {},
        "metadata": {}
      },
      "queue": {
        "queueId": "string",
        "approvalGroups": [
          "string"
        ]
      },
      "mappings": [
        {
          "mappingId": "string"
        }
      ],
      "decision": {
        "conditions": [
          {
            "all": [
              {
                "source": {},
                "operator": "EQ",
                "stringValue": "string",
                "numberValue": 0,
                "booleanValue": true,
                "stringValues": [
                  "string"
                ]
              }
            ],
            "any": [
              {
                "source": {},
                "operator": "EQ",
                "stringValue": "string",
                "numberValue": 0,
                "booleanValue": true,
                "stringValues": [
                  "string"
                ]
              }
            ],
            "transition": {
              "type": "STEP",
              "stepId": "string"
            }
          }
        ],
        "defaultTransition": {
          "type": "STEP",
          "stepId": "string"
        }
      },
      "decisions": [
        {
          "type": "APPROVE",
          "nextStepId": "string"
        }
      ]
    }
  ]
}

Loading...