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": [
"c14d9d2a99f26e958144a07e",
"7eb3b3556fba96dd7d142ad9",
"e4672c233d6ac0821ad156f8"
],
"nodeLocation": {
"x": 36429232.18141508,
"y": 45715425.10575983
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"2eb7999f97e0acc6490c86bd"
],
"nodeLocation": {
"x": 74286519.0011797,
"y": 14398256.086280674
}
},
"error_handler": {
"name": "childJob",
"summary": "et dolor culpa id",
"description": "occaecat dolor officia incididunt",
"app": "consectetur in anim",
"variables": {
"error": ""
},
"groups": [
"7dba223bb4c0a3c90e17faef",
"e3bc82272316595f3f72de04",
"23c5416038fed8f99eaebaea",
"89ad884a5f539e3537171f94",
"1230fe26eccf0d040a68973a"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"b107e12f8ab40fcb4a61f649",
"82f0cb1af355dfdbf4c7ffed"
],
"canvasVersion": 3,
"_id": "5cb7b531d06cceb89fd21b1c",
"namespace": {
"type": "project",
"name": "pariatur labore laboris proident",
"accessControl": {
"read": [
"laboris",
"dolor esse non occaecat anim",
"tempor consectetur ipsum",
"dolore id anim in tempor"
],
"write": [
"amet nostrud dolor occaecat eiusmod",
"ea aute ut nulla"
],
"execute": [
"fugiat ut mollit elit",
"ea ex",
"enim magna est reprehenderit voluptate",
"irure Lorem magna cupidatat id",
"dolore ipsum velit ex nulla"
],
"manage": [
"ex consequat in anim",
"deserunt",
"ullamco"
]
}
},
"description": "voluptate ut dolore do ea",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2002-04-13T09:11:32.549Z",
"created_by": "8987294be91cc00e9503c554",
"last_updated": "2013-10-30T10:52:50.256Z",
"last_updated_by": "dd93f6c8ba5541c001a45fc6",
"lastUpdatedVersion": "Ut Duis quis eu ut",
"tags": [
"officia magna mollit est",
"elit",
"commodo do ut"
],
"encodingVersion": 1
}