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": "quis nostrud aute et nulla",
"description": "ea laborum pariatur",
"app": "quis sit cillum sunt",
"variables": {
"error": ""
},
"groups": [
"8f6b422755b09c8ccd9515a7",
"d35621430f8386d060cb6bc7",
"afff9143f974bdfacfeb9595"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"error",
"failure"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a9225fb03a23a66a254c04b9",
"0e6ea46c17be84ef2de57c52"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "tempor",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1980-08-27T09:55:19.089Z",
"created_by": "94d9f39c35622f406a58b2d6",
"last_updated": "2010-06-10T17:11:08.859Z",
"last_updated_by": "99a148979fe3780455523acb",
"lastUpdatedVersion": "do occaecat",
"tags": [],
"canvasVersion": 2
}