Get Workflow

Get workflow is an operator task that retrieves the workflow execution details using the workflow ID.

Definitions

   {
     "name": "get_workflow",
     "taskReferenceName": "get_workflow_ref",
     "inputParameters": {
       "id": "e27cf59c-0851-11ef-9a82-c62f15439f28",
       "includeTasks": true
     },
     "type": "GET_WORKFLOW",
   }

Input Parameters

Parameter	Description
id	Provide the workflow ID of the workflow. You can also pass this parameter as a variable.
includeTasks	Set this to true or false, depending on whether to retrieve the task details or not.

note

You can get the workflow details only if you have at least read permission to the workflow. Otherwise, the workflow fails with an error message like this:

Output Parameters

The workflow output gives all the details of the retrieved workflow. View an example here.

Examples

UI

1. Add task type Get Workflow.
2. Provide the workflow ID.

JSON

  {
     "name": "get_workflow",
     "taskReferenceName": "get_workflow_ref",
     "inputParameters": {
       "id": "e27cf59c-0851-11ef-9a82-c62f15439f28",
       "includeTasks": true
     },
     "type": "GET_WORKFLOW",
  }