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": [
"adf11bf0e150b96f290cb795",
"12d9949362a02f6a62a433e6"
],
"nodeLocation": {
"x": -37495242.84878589,
"y": 76150572.51010206
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"8bf44c01d3f8a4e8f2c67af7",
"ad48d782e4274d6cf34f0b62",
"f138d3625f4807deb8248722",
"0f4be2eca0fc0a6c19775887"
],
"gridCoordinate": {
"x": 91555290.48340744,
"y": 66748999.53248915
}
},
"error_handler": {
"name": "childJob",
"summary": "ex pariatur reprehenderit nostrud consequat",
"description": "culpa incididunt",
"app": "pariatur ullamco",
"variables": {
"error": ""
},
"groups": [
"bb08081ad9b2224517d3ac0d",
"d1a8ab81fc453a4dbe358c62",
"e1260b774096f7093949378f",
"2f7e5441a73a7492c8ba2ac0"
],
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"success",
"error",
"success"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"5d0e1a20b3b3ebd67ea02d7d",
"36c7c4ce8defad8f084bf05b"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1974-07-09T15:49:22.739Z",
"created_by": "f02a0d5ce66a57f4eb7b8d32",
"last_updated": "1957-04-14T22:53:36.594Z",
"last_updated_by": "57a80e62631d6b98ebf5a20f",
"lastUpdatedVersion": "Ut exercitation culpa",
"tags": [
"officia esse et Excepteur",
"Lorem nostrud"
],
"canvasVersion": 2,
"encodingVersion": 1
}