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": "occaecat Ut",
"description": "magna qui",
"app": "fugiat exercitation",
"variables": {
"error": ""
},
"groups": [
"14d71f9c4d8e34cfe4f6ba57",
"b980298a9d0d657f19c29cfb",
"a9d8d808ebfeaed59144047a",
"5f5c51005828cb724d29f906"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"error"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"6722ada0dc8d5dd540693353",
"cd6c1b21c006d28cda3b6d90",
"2c07b6d2bb5a10246794dbde"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1994-01-15T12:16:51.814Z",
"created_by": "6001052551132e69196f5960",
"last_updated": "1969-05-15T10:47:31.34Z",
"last_updated_by": "9fb4e85c29babab1941004d9",
"lastUpdatedVersion": "aute",
"tags": [],
"canvasVersion": 1
}