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": "amet dolore",
"description": "magna sed ad adipisicing",
"app": "voluptate dolor ex Duis in",
"variables": {
"error": ""
},
"groups": [
"837ee358d00e4a051115dfad",
"da429209362ee10dd13d6e2e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"7622c960ccf610716518be19",
"b6034c698c08c2a617330711",
"0f058d0a99843b9a3303eb66",
"bf70d71acef913a840bb4ef1",
"b18d8bc2f0ee0d7f52656931"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "pariatur cillum quis ut veniam",
"preAutomationTime": 250000,
"font_size": 12,
"created": "2000-08-09T21:44:46.219Z",
"created_by": "627b9b5b26fadea13a7d3985",
"last_updated": "2007-01-27T11:24:05.346Z",
"last_updated_by": "06b2ef511cfbb7dbb063e19d",
"lastUpdatedVersion": "enim",
"tags": [],
"canvasVersion": 1
}