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": null
31     }
32   },
33   "transitions": {
34     "workflow_start": {},
35     "workflow_end": {},
36     "error_handler": {}
37   },
38   "groups": [
39     {
40       "name": "Admin",
41       "provenance": "LocalAAA"
42     }
43   ],
44   "_id": "string",
45   "uuid": "string",
46   "description": "Upgrade Cisco IOS device",
47   "namespace": null,
48   "preAutomationTime": 5000,
49   "sla": 1,
50   "metadata": {
51     "preAutomationTime": 1,
52     "sla": 1
53   },
54   "scenarios": [
55     {
56       "name": "string",
57       "input": {},
58       "description": "string",
59       "taskMocks": {},
60       "last_updated": "2024-01-15T09:30:00Z",
61       "last_updated_by": {
62         "username": "admin@pronghorn",
63         "provenance": "Pronghorn"
64       }
65     }
66   ],
67   "errorHandler": null,
68   "font_size": 12,
69   "created": "2024-03-13T18:21:15.352Z",
70   "created_by": {
71     "username": "admin@pronghorn",
72     "provenance": "Pronghorn"
73   },
74   "createdVersion": "5.40.5-2021.1.72.0",
75   "last_updated": "2024-03-13T18:21:15.352Z",
76   "last_updated_by": {
77     "username": "admin@pronghorn",
78     "provenance": "Pronghorn"
79   },
80   "lastUpdatedVersion": "4.69.69",
81   "tags": [
82     {
83       "_id": "string",
84       "name": "string",
85       "description": "string"
86     }
87   ],
88   "canvasVersion": 1,
89   "encodingVersion": 1,
90   "inputSchema": {},
91   "outputSchema": {},
92   "outputData": {},
93   "decorators": [
94     {
95       "type": "encryption",
96       "pointer": "/outgoing/output"
97     }
98   ],
99   "migrationVersion": 1
100 }

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

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

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

descriptionstring or null

namespaceobject or null

preAutomationTimeinteger

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

slainteger

metadataobject

Deprecated. If present, preAutomationTime and sla are lifted to the top level on import; this property is not persisted.

scenarioslist of objects

errorHandlerobject or null

Deprecated gen2-specific feature

font_sizeinteger6-24Defaults to 12

Deprecated, unused, gen1-specific feature

createdstringformat: "date-time"

created_byobject or string

createdVersionstring

last_updatedstringformat: "date-time"

last_updated_byobject or string

lastUpdatedVersionstring

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 objects

canvasVersionenum

encodingVersionenum

inputSchemaobject

outputSchemaobject

outputDatamap from strings to objects

Deprecated gen2-specific feature

decoratorslist of objects

migrationVersioninteger>=0

Errors

500

Internal Server Error