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": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "tempor incididunt ex",
"description": "elit eiusmod",
"app": "proident",
"variables": {
"error": ""
},
"groups": [
"5af9cc110a33e63de9fd0ade",
"9da49aec8c52f4be36525c88",
"edc84ef8aca1cb219f9b2d6c",
"c6261396c52fa837c4083132",
"0e6a142c4e62d72256c73ed3"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"failure",
"success"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"15dd0388b7a68dc8cfbf2a5c",
"a662b78f6afbf4f75f3e1181"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "ullamco ex ipsum quis et",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1974-10-02T00:02:29.65Z",
"created_by": "7d0ac934e36a356cb3a20f3c",
"last_updated": "2002-07-22T08:33:19.071Z",
"last_updated_by": "fc004489a040c6d06a85f636",
"lastUpdatedVersion": "dolor irure velit minim adipisicing",
"tags": [],
"canvasVersion": 1
}
