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": [
"19fab58eea13ea4bdd096060"
]
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"2edb1c298652a955bc85cfdc",
"f3f6a618933f1b0b51b539ba",
"41d6eb696bd5887c658a34a2",
"49034906519501a362d689da"
]
},
"error_handler": {
"name": "childJob",
"summary": "aliquip enim eu esse",
"description": "id laboris dolor incididunt dolor",
"app": "deserunt ut non sit culpa",
"variables": {
"error": ""
},
"groups": [
"8e131d61eb76bf2140a43e3a"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"success",
"success",
"error"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"14ebac7062eddb197eb0dc8f",
"32613ae0070ff214018bcfec",
"b248aeadcff03c72df9a2a56",
"a4fded79fbb9d101bffc1cfd"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1979-10-18T02:04:32.016Z",
"created_by": "b7557fd43475bb34214ec7cb",
"last_updated": "1977-02-07T10:57:06.76Z",
"last_updated_by": "727c56daff2fdbb522e8d7a3",
"lastUpdatedVersion": "consectetur",
"tags": [
"pariatur",
"ex"
],
"canvasVersion": 2,
"encodingVersion": 1
}
