REST API

Workflow

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!

Representation of a Workflow.

Resource Representation

{
  "entity-type": "workflow",
  "id": string,
  "name": string,
  "title": string,
  "state": string,
  "workflowModelName": string,
  "initiator": string | User entity,
  "attachedDocumentIds": [
    { "id": string } | Document entity
  ],
  "variables": object,
  "graphResource": string,
  "contextParameters": object
}
Property Name Value Description Notes
entity-type string The entity type name. Value: the fixed string "workflow".
id string The workflow id.
name string The workflow name.
title string The workflow title.
state string The workflow life cycle state.
workflowModelName string The workflow model name.
initiator string
or object
The workflow initiator id.
Or the workflow initiator user entity, if the fetch property initiator is set.
attachedDocumentIds list The list of attached document ids.
Or the list of attached document entities, if the fetch property attachedDocumentIds is set.
variables object A collection of key-value pairs of workflow variables. Optional, present if the workflow is an instance.
graphResource string The workflow graph resource URL. Optional, present if the workflow is an instance.
contextParameters object A collection of key-value pairs filled by enabled enrichers. Optional

We'd love to hear your thoughts!

All fields required