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": [
"b2504e4b78da6e59dda74cfb",
"d136f371d58dd5e591fedf0b",
"8299da99b12b83013ed19595",
"60793059918191c35359d8bf",
"5f68c4f80db95b550ed4ced3"
],
"nodeLocation": {
"x": 72963014.0313848,
"y": -15435231.26726231
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"26f58c1b4fbde5f3aefe46ba",
"736f9300223f6a4df504940b"
],
"x": -54010186.96277231,
"y": -92301453.30500159
},
"error_handler": {
"name": "childJob",
"summary": "ad labore",
"description": "fugiat",
"app": "sit irure",
"variables": {
"error": ""
},
"groups": [
"b324f5e5fc19a40cdf541e8a",
"52f27465359c985570ee784a"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure",
"success",
"success",
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"aa3230cef39e286101682ab9",
"ed34a1a772c67ef29334719b",
"4a27e30e41001eb303d29904",
"6e0774c44e6738c7ad3932fc"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "minim aliqua",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2023-09-24T12:43:44.934Z",
"created_by": "70b18574be7f244bc138dec8",
"last_updated": "1983-09-15T16:58:58.889Z",
"last_updated_by": "e314db95b7cbfc6057efbbef",
"lastUpdatedVersion": "adipisicing culpa in Ut",
"tags": [
"ad adipisicing sed",
"dolor Duis ad in nulla"
],
"canvasVersion": 2,
"encodingVersion": 1
}