Summary
Get Details of a Workflow
Description
Get the details of a Workflow by Workflow name.
Route
GET /automation-studio/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": "incididunt",
"description": "sed quis",
"app": "nostrud",
"variables": {
"error": ""
},
"groups": [
"e60c6cb0fbfa1995dc0b14c5",
"806e6b0b642f1ad098f11293",
"8ef7fdaf38cb752a1763aca6",
"e21b12745a9e30c3d9f9ef21",
"489adc8b7bd876848dd9c6c8"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"b1bff4314afc28c94a4e74b8",
"bf03f0f2175c8841f26eacc8"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "fugiat ipsum anim non irure",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1990-08-08T23:15:48.864Z",
"created_by": "0aa247d2860c2b42c7703b3b",
"last_updated": "2018-07-05T07:42:37.887Z",
"last_updated_by": "f82f052d38f16c8bfa9f74ea",
"lastUpdatedVersion": "eiusmod enim esse non laborum",
"tags": [],
"canvasVersion": 1
}
