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": "aute sint",
"description": "quis in incididunt",
"app": "adipisicing cillum in exercitation",
"variables": {
"error": ""
},
"groups": [
"bcd515dd9d00899ff23608ec",
"fe8a6c4ae0d89eb651587750",
"7953950e0793e637bb659cff"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"error"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a811779099444142e3e2193c",
"4f86357129c2d9b1d2794723",
"ceea0ca87d3f5d51862214e2",
"d91ed0115b579168bc859e5c",
"e8de6b4a1e6bf49072b1a07b"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1954-10-23T22:08:27.876Z",
"created_by": "07df33ccaa3721f8d16637a9",
"last_updated": "1988-12-03T17:36:58.904Z",
"last_updated_by": "ab2b4c1d3315cbd87aaaf833",
"lastUpdatedVersion": "tempor",
"tags": [],
"canvasVersion": 1
}