Export workflow

POST

http://localhost:3000/workflow_builder/export

POST

/workflow_builder/export

$ curl -X POST http://localhost:3000/workflow_builder/export \
>      -H "Content-Type: application/json" \
>      -u "<username>:<password>" \
>      -d '{}'

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

Exports a single Workflow.

Authentication

AuthorizationBasic

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

Request

request body

optionsanyOptional

Response

Exported Workflow

namestring

typestringDefaults to automation

tasksobject

transitionsobject

groupslist of objects

_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}$"

descriptionstring or nullOptional

namespaceobject 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_byobject or nullOptional

createdVersionstringOptional

last_updatedstringOptionalformat: "date-time"

last_updated_byobject or nullOptional

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 objectsOptional

canvasVersionenumOptional

encodingVersionenumOptional

inputSchemaobjectOptional

outputSchemaobjectOptional

outputDatamap from strings to objectsOptional

Deprecated gen2-specific feature

decoratorslist of objectsOptional

migrationVersionintegerOptional>=0

Errors

500

Internal Server Error