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": [
"8a0e904a4f66f944711c94a5",
"21810dbbc26dcc6210f358e0"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"ce7e1065d805a806a072ca54",
"4dcf36867120be57bb419d64",
"d2d57db91057f391a7be8570",
"d6f6978bcf0237b83cc2c7fb",
"d7458ba842a513196b0e581a"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "ullamco id",
"description": "commodo anim sed qui elit",
"app": "adipisicing fugiat dolor incididunt voluptate",
"variables": {
"error": ""
},
"groups": [
"ecb01000ce032e30c98e47aa",
"73541ebce70575e8df5285d0"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"success",
"failure",
"error",
"failure"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"f4ee650264558f3e1f4d5e26",
"0908de838ed5544ee431598f",
"1ff8d22c3b2b2f18dfa0fc30",
"3f91a638e9e260985a9d9f2b",
"020ebc09d8aa9f9ff3ae9f24"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1984-01-25T08:31:34.859Z",
"created_by": "d6d99ff8214b661ee74af04f",
"last_updated": "1978-04-12T00:43:26.252Z",
"last_updated_by": "e3b3dc78a681fa875d230c18",
"lastUpdatedVersion": "Duis magna in do",
"tags": [
"tempor fugiat consectetur dolor magna",
"Excepteur tempor",
"culpa do",
"dolor consectetur in"
],
"canvasVersion": 2,
"encodingVersion": 1
}