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": "veniam ullamco sed incididunt",
"description": "veniam adipisicing qui reprehenderit",
"app": "aliquip velit Excepteur",
"variables": {
"error": ""
},
"groups": [
"270d933415971727f74b5a1b",
"acfe9121159833992dc06354",
"7ac9e66040da9a2209edbc9e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"failure",
"failure"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"da42dc0d02b7c4da075d305c",
"251472d9cfe8604b1cab249a",
"ef0ded2d7d0ed9bd06817efc",
"c4566fdf94461774edcf882c"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "reprehenderit aliquip ex",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1979-05-03T15:01:34.436Z",
"created_by": "12820f354a949e7263afcba2",
"last_updated": "1966-12-01T08:12:33.374Z",
"last_updated_by": "717de97b353cf3a31958f674",
"lastUpdatedVersion": "nisi do",
"tags": [],
"canvasVersion": 1
}