Summary
Get Details of a Workflow
Description
Get the details of a Workflow by Workflow name.
Route
GET /workflow_engine/workflows/detailed/:name
Roles
admin
engineering
support
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
name |
string |
yes |
Name of Workflow to get Workflow details. |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
workflow_details |
object |
Workflow details matching the Workflow name. |
Copied to Clipboard
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [
"ad5171e1a8c41d473bd73dc9",
"98020733ce18108aec940fd3",
"59922f13da5bcef6f3ea0193",
"5ce34d7c6d8e3e77259b9b38",
"4d98e3df85443ab73ee02808"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"ab8f441a776ded17459391d3",
"c1a40724d33fb5f7a8f5cbc3",
"1023a99aaa2dc3c556560831"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "proident exercitation",
"description": "dolore Lorem in qui nostrud",
"app": "culpa dolor quis nisi",
"variables": {
"error": ""
},
"groups": [
"451c7e33b17662601871415c",
"85d39f242127d75dbe069836",
"6be84aceda4895a87fd9fb95",
"2fbd6921f2209dcdcc072df9"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"2d29dc68fc735869ace99c95",
"fc9dae0126f1fd71eccd2e00",
"6df5789d9f80ba31013ff765",
"283a60d65b4af1056e3e1d4c",
"b6a2340cce56dfc074f5b53d"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "consectetur",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2007-07-25T15:47:06.513Z",
"created_by": "db62336787df72b063696f33",
"last_updated": "1949-11-21T10:53:59.549Z",
"last_updated_by": "058a56a1bd8028e84d04252d",
"lastUpdatedVersion": "proident ex reprehenderit",
"tags": [
"magna Excepteur aliqua in",
"incididunt eiusmod in Lorem",
"reprehenderit pariatur aliqua est occaecat"
],
"canvasVersion": 2,
"encodingVersion": 1
}