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": "nulla nisi",
"description": "ipsum",
"app": "qui ut sunt",
"variables": {
"error": ""
},
"groups": [
"5936b0150634a85281a4a1ef"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"d425e927a7089d9a2ceb33ae",
"8ef4a9e6d262c94c4417eef9",
"cb3a44e7d6191e5b6d507368",
"f5b0107701992cf1a8705cfe"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1993-03-29T21:54:26.672Z",
"created_by": "4c0e7330c2157ab5df95eeec",
"last_updated": "2021-05-27T10:54:48.056Z",
"last_updated_by": "bdbc0c2634f4c803f80f9b6e",
"lastUpdatedVersion": "laborum occaecat",
"tags": [],
"canvasVersion": 1
}