For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd group to workflow
        • POSTAdd workflow
        • POSTCalculate workflow schemas
        • DELDelete all groups for a workflow
        • DELDelete workflow
        • POSTExport workflow
        • GETGet task details
        • GETGet tasks
        • POSTImport workflow
        • GETList groups for a workflow
        • PUTOverwrite groups for a workflow
        • DELRemove a group from a workflow
        • POSTRename workflow
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceWorkflow Builder

Add workflow

POST
http://localhost:3000/workflow_builder/workflows/save
POST
/workflow_builder/workflows/save
$curl -X POST http://localhost:3000/workflow_builder/workflows/save \
>     -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        "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": null
29    }
30  },
31  "transitions": {
32    "workflow_start": {},
33    "workflow_end": {},
34    "error_handler": {}
35  },
36  "groups": [
37    "string"
38  ],
39  "scenarios": [
40    {
41      "name": "string",
42      "input": {},
43      "description": "string",
44      "taskMocks": {},
45      "last_updated": "2024-01-15T09:30:00Z",
46      "last_updated_by": {
47        "username": "admin@pronghorn",
48        "provenance": "Pronghorn"
49      }
50    }
51  ],
52  "_id": "string",
53  "uuid": "string",
54  "description": null,
55  "namespace": null,
56  "preAutomationTime": 5000,
57  "sla": 1,
58  "errorHandler": null,
59  "font_size": 12,
60  "created": "2024-01-15T09:30:00Z",
61  "created_by": {
62    "username": "admin@pronghorn",
63    "provenance": "Pronghorn"
64  },
65  "createdVersion": "5.40.5-2021.1.72.0",
66  "last_updated": "2024-01-15T09:30:00Z",
67  "last_updated_by": {
68    "username": "admin@pronghorn",
69    "provenance": "Pronghorn"
70  },
71  "lastUpdatedVersion": "4.69.69",
72  "tags": [
73    "string"
74  ],
75  "canvasVersion": 1.1,
76  "encodingVersion": 1,
77  "inputSchema": {},
78  "outputSchema": {},
79  "outputData": {},
80  "decorators": [
81    {
82      "type": "encryption",
83      "pointer": "string"
84    }
85  ],
86  "migrationVersion": 1
87}
Adds a Workflow to the database.
Was this page helpful?
Previous

Calculate workflow schemas

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
workflowobjectOptional
Third generation workflow document as it exists in the database

Response

The new Workflow with its data and ID.
namestring
typestringDefaults to automation
tasksobject
transitionsobject
groupslist of strings
scenarioslist 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
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 strings
canvasVersiondouble
encodingVersionenum
Allowed values:
inputSchemaobject
outputSchemaobject
outputDatamap from strings to objects

Deprecated gen2-specific feature

decoratorslist of objects
migrationVersioninteger>=0

Errors

500
Internal Server Error