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": "id ut veniam proident aute",
"description": "nostrud quis dolore ad pariatur",
"app": "in",
"variables": {
"error": ""
},
"groups": [
"35fed72fba4bf446218bdef3",
"bcbd5d8311c7e665057bfdcc",
"1a3c01fcd1bba55b39c8e50e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success",
"error",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"d9291a691490d3acbe84f871",
"2c0bc0febb9e1cfec8c7d633",
"f51ffa295bfb7dcc79a391ae",
"c920b650de93c7962f8362ab",
"b9cdf13298c1eb5b7f1bc8bf"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1977-06-12T21:13:37.578Z",
"created_by": "80208ac2070ba777ba71085b",
"last_updated": "1974-08-02T19:31:04.594Z",
"last_updated_by": "e104a147a5c348dcfe457c5e",
"lastUpdatedVersion": "ex Duis ipsum consequat reprehenderit",
"tags": [],
"canvasVersion": 2
}