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 magna ut dolore est",
"description": "consequat amet",
"app": "ullamco aliqua mollit commodo",
"variables": {
"error": ""
},
"groups": [
"817b505fffce073c14400106",
"8f38b87c92e3d2144edc73b6",
"26e4b3634276425ff977e09d",
"68242daa43448bc0a77ca1e7",
"947e77ccdc67f653ddf533f9"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure",
"error",
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"b54cf2ffd4d17f11b22faf21",
"7e59ec565d0ce87cdd34a3af",
"7c29459e23f858297588e069"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "eiusmod",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1958-11-24T04:29:05.984Z",
"created_by": "dc2cacba3e6d54367df53d70",
"last_updated": "1948-09-26T04:44:39.951Z",
"last_updated_by": "cb0918cf60ca13b47f64a5f3",
"lastUpdatedVersion": "aliquip aute exercitation",
"tags": [],
"canvasVersion": 1
}