Export workflow

POST

https://example.itential.io/workflow_builder/export

POST

/workflow_builder/export

$ curl -X POST https://example.itential.io/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   "metadata": {
83     "preAutomationTime": 1,
84     "sla": 1
85   },
86   "scenarios": [
87     {
88       "name": "string",
89       "input": {},
90       "description": "string",
91       "taskMocks": {},
92       "last_updated": "2024-01-15T09:30:00Z",
93       "last_updated_by": {
94         "provenance": "Pronghorn",
95         "username": "admin@pronghorn"
96       }
97     }
98   ],
99   "errorHandler": null,
100   "font_size": 12,
101   "created": "2024-03-13T18:21:15.352Z",
102   "created_by": {
103     "provenance": "Pronghorn",
104     "username": "admin@pronghorn"
105   },
106   "createdVersion": "5.40.5-2021.1.72.0",
107   "last_updated": "2024-03-13T18:21:15.352Z",
108   "last_updated_by": {
109     "provenance": "Pronghorn",
110     "username": "admin@pronghorn"
111   },
112   "lastUpdatedVersion": "4.69.69",
113   "tags": [
114     {
115       "_id": "string",
116       "name": "string",
117       "description": "string"
118     }
119   ],
120   "canvasVersion": 1,
121   "encodingVersion": 1,
122   "inputSchema": {},
123   "outputSchema": {},
124   "outputData": {},
125   "decorators": [
126     {
127       "type": "encryption",
128       "pointer": "/outgoing/output"
129     }
130   ],
131   "migrationVersion": 1
132 }

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

metadataobjectOptional

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

scenarioslist of objectsOptional

errorHandlerobject or nullOptional

Deprecated gen2-specific feature

font_sizeintegerOptional6-24Defaults to 12

Deprecated, unused, gen1-specific feature

createdstringOptionalformat: "date-time"

created_byobject or stringOptional

createdVersionstringOptional

last_updatedstringOptionalformat: "date-time"

last_updated_byobject or stringOptional

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