Summary
Find Forward Paths
Description
Find the paths between two Tasks in a Workflow by Task ids and Workflow details.
Route
POST /workflow_engine/findForwardPaths
Roles
admin
engineering
support
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| start_task |
string |
yes |
Id of the start Task. |
| end_task |
string |
yes |
Name of the end Task. |
| workflow_details |
object |
yes |
Workflow data which contain the tasks and transitions properties of the workflow. |
Copied to Clipboard
{
"start_task": "workflow_start",
"end_task": "workflow_end",
"workflow_details": {
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
}
},
"transitions": {},
"groups": [
"020cb1ed43fdf832754f22ea",
"d64dc107e4ad741a9446bce5",
"230d50a10d014d9776dbe67a"
],
"_id": "324373cb-5914-c23e-4e33-60f3476dfc0f",
"description": "et veniam occaecat consequat in",
"font_size": 12,
"created": "1989-11-06T13:50:17.039Z",
"created_by": "7ebc1ddd9818353cbb560df1",
"last_updated": "2013-02-27T12:28:13.34Z",
"last_updated_by": "9ba80ac4f7e401d9133f997d",
"tags": []
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"start_task": {
"type": "string",
"title": "start_task",
"$ref": "wfEngineCommon#/definitions/workflowTaskId",
"examples": [
"workflow_start"
]
},
"end_task": {
"type": "string",
"title": "end_task",
"$ref": "wfEngineCommon#/definitions/workflowTaskId",
"examples": [
"workflow_end"
]
},
"workflow_details": {
"$ref": "workflowDocument"
}
},
"required": [
"start_task",
"end_task",
"workflow_details"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| all_paths |
array |
All valid paths between the Tasks. |
Copied to Clipboard
[
[
"workflow_start",
"workflow_end"
],
[
"workflow_start",
"abcd",
"workflow_end"
]
]
Copied to Clipboard
{
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "wfEngineCommon#/definitions/workflowTaskId"
}
},
"examples": [
[
[
"workflow_start",
"workflow_end"
],
[
"workflow_start",
"abcd",
"workflow_end"
]
]
]
}
