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": [
"369e22fc9935fb6ad3d9eddf"
],
"nodeLocation": {
"x": -26637403.79991992,
"y": 26046276.878008753
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"146761c2910590ea758d1995",
"308fda2b5369481fb2b0cd09",
"5a41c6d43155d14dafa07494"
],
"x": -38592204.9231632,
"y": 73106594.91678241
},
"error_handler": {
"name": "childJob",
"summary": "id cillum nulla",
"description": "in labore sed",
"app": "exercitation ut",
"variables": {
"error": ""
},
"groups": [
"f4669672e7c969dc94bd0de5",
"d97a23527193d966debe5c7b"
],
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"failure",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a40793cb20a3812fe6a6ec0b",
"3f390c59b4de7cb3f6738527",
"824edb43348b6a8242021a1c",
"6b1f952d2399187e4f2c9c9f"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "dolor",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2002-05-25T13:09:41.208Z",
"created_by": "78946b4beda80c6ea3413fc7",
"last_updated": "2016-09-21T05:34:31.739Z",
"last_updated_by": "9301a2c1ca3b2bd7fe0adcda",
"lastUpdatedVersion": "eu et non dolor",
"tags": [
"consectetur sint voluptate veniam Excepteur",
"magna cillum esse aliquip irure"
],
"canvasVersion": 1,
"encodingVersion": 1
}