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": "eu do in Lorem",
"description": "exercitation tempor culpa et qui",
"app": "dolore",
"variables": {
"error": ""
},
"groups": [
"e7b7e9222686264a222aa44f",
"0fcc227a2d151d3f6f4cc74d",
"957aadc5b3312ee6b9d6d821",
"77cdf320862fd6b822ea3f79"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success",
"failure",
"success",
"failure"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a9f3231bbd00ffd8ba25a7d4",
"9c29a5ced04ace5f395c5e20",
"e0ee8c3e52b24283d32486d7"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "voluptate",
"preAutomationTime": 250000,
"font_size": 12,
"created": "2017-05-02T03:59:04.009Z",
"created_by": "2e9779e97b8c3c49ce4dea11",
"last_updated": "1955-07-19T15:03:45.309Z",
"last_updated_by": "03723d45046d16d8c0f9964d",
"lastUpdatedVersion": "cillum esse anim veniam",
"tags": [],
"canvasVersion": 2
}