Get details of a workflow

GET

http://localhost:3000/automation-studio/workflows/detailed/:name

GET

/automation-studio/workflows/detailed/:name

$ curl http://localhost:3000/automation-studio/workflows/detailed/name \
>      -u "<username>:<password>"

1 {
2   "name": "Port Turn Up IOS",
3   "type": "automation",
4   "tasks": {
5     "workflow_start": {
6       "name": "string",
7       "summary": "string",
8       "groups": [
9         "string"
10       ],
11       "nodeLocation": {
12         "x": 1.1,
13         "y": 1.1
14       }
15     },
16     "workflow_end": {
17       "name": "string",
18       "summary": "string",
19       "groups": [
20         "string"
21       ],
22       "nodeLocation": {
23         "x": 1.1,
24         "y": 1.1
25       }
26     },
27     "error_handler": {
28       "name": "string",
29       "summary": "string",
30       "description": "string",
31       "app": "string",
32       "variables": {
33         "incoming": {},
34         "outgoing": {},
35         "error": "string",
36         "decorators": [
37           {
38             "type": "encryption",
39             "pointer": "string"
40           }
41         ]
42       },
43       "groups": [
44         "string"
45       ],
46       "type": "string",
47       "nodeLocation": {
48         "x": 1.1,
49         "y": 1.1
50       },
51       "deprecated": true,
52       "scheduled": true,
53       "retrySettings": {
54         "state": [
55           "success"
56         ],
57         "autoRetry": true,
58         "limit": 10,
59         "delay": 1000,
60         "count": 5
61       }
62     }
63   },
64   "transitions": {
65     "workflow_start": {},
66     "workflow_end": {},
67     "error_handler": {}
68   },
69   "groups": [
70     "string"
71   ],
72   "canvasVersion": 1.1,
73   "_id": "string",
74   "uuid": "string",
75   "namespace": {
76     "type": null,
77     "_id": {},
78     "name": "string",
79     "accessControl": {
80       "read": [
81         "string"
82       ],
83       "execute": [
84         "string"
85       ],
86       "write": [
87         "string"
88       ],
89       "manage": [
90         "string"
91       ]
92     }
93   },
94   "description": "Port Turn Up IOS",
95   "preAutomationTime": 5000,
96   "sla": 1,
97   "errorHandler": null,
98   "font_size": 12,
99   "created": "2024-03-13T18:21:15.352Z",
100   "createdVersion": "5.40.5-2021.1.72.0",
101   "last_updated": "2024-03-13T18:21:15.352Z",
102   "lastUpdatedVersion": "4.69.69",
103   "tags": [
104     "string"
105   ],
106   "encodingVersion": 1,
107   "inputSchema": {},
108   "outputSchema": {},
109   "outputData": {},
110   "decorators": [
111     {
112       "type": "encryption",
113       "pointer": "string"
114     }
115   ],
116   "migrationVersion": 1
117 }

Returns the details of a Workflow by Workflow name.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

namestringRequired

Name of Workflow to get Workflow details.

Response

Workflow details matching the Workflow name.

namestring

typestringDefaults to automation

tasksobject

transitionsobject

groupslist of strings

canvasVersiondouble

_idstringOptionalformat: "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"

uuidstringOptionalformat: "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"

namespaceobjectOptional

descriptionstring or nullOptional

preAutomationTimeintegerOptional

Time (milliseconds) automation would have taken someone to complete without using IAP.

slaintegerOptional

errorHandlerobject or nullOptional

Deprecated gen2-specific feature

font_sizeintegerOptional6-24Defaults to 12

Deprecated, unused, gen1-specific feature

createdstringOptionalformat: "date-time"

created_byanyOptional

createdVersionstringOptional

last_updatedstringOptionalformat: "date-time"

last_updated_byanyOptional

lastUpdatedVersionstringOptional

This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.

tagslist of stringsOptional

encodingVersionenumOptional

inputSchemaobjectOptional

outputSchemaobjectOptional

outputDatamap from strings to objectsOptional

Deprecated gen2-specific feature

decoratorslist of objectsOptional

migrationVersionintegerOptional>=0

Errors

500

Internal Server Error