Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_builder/export
Roles
admin
apiread
Parameters
Details Example Schema
Name
Type
Required
Description
options
object
yes
match a workflow using _id or name. Type may be included as an additional filter when using name.
Copied to Clipboard
{
"options": {
"_id": "5cb7b531d06cceb89fd21b1c",
"name": "someWorkflowName",
"type": "labore dolore sint"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"title": "MongoDB ObjectId",
"description": "Id of Workflow document",
"examples": [
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c"
]
},
"name": {
"type": "string",
"description": "The name of the workflow. When provided, 'type' can also be specified for additional filtering.",
"examples": [
"someWorkflowName"
]
},
"type": {
"type": "string",
"description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering."
}
},
"required": [
"_id",
"name"
],
"oneOf": [
{
"required": [
"_id"
]
},
{
"required": [
"name"
]
}
],
"additionalProperties": false
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
workflow
object
Exported Workflow
Copied to Clipboard
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": -24489527.763700366,
"y": 26254240.050765216
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 55889812.78121832,
"y": -9666405.32301253
},
"error_handler": {
"name": "childJob",
"summary": "nostrud",
"description": "elit nisi aliquip esse",
"app": "non cupidatat incididunt",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~0/YopfD/~0/~1/L/rc/~1"
},
{
"type": "encryption",
"pointer": "/LDg+o/q6MIxf2i1o1/CjGk-CXaT/viUdLWft1W/~0/~1/~1/~1/Y"
},
{
"type": "encryption",
"pointer": "/IK1vF0c1KMu/XGhPJbJqlN-/~1/~0/~1/~1/g9Xasq-d/PzAjDReA/~0/~0"
},
{
"type": "encryption",
"pointer": "/~1/~1/~1/~0/Okb5S/siH6j-n"
}
]
},
"groups": [
{
"name": "elit dolore reprehenderit",
"provenance": "et ipsum sit"
},
{
"name": "ea ullamco sit",
"provenance": "adipisicing commodo elit"
},
{
"name": "ipsum id fugiat",
"provenance": "est nisi in reprehenderit"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "laborum cillum laboris anim",
"provenance": "sit"
},
{
"name": "exercitation labore",
"provenance": "dolore"
},
{
"name": "commodo est ea sint deserunt",
"provenance": "anim aliqua dolore non"
},
{
"name": "id dolor ad",
"provenance": "dolor sunt"
}
],
"_id": "fd4b2fa6-f4f7-6a58-0bb0-5bb4cccbb098",
"description": null,
"errorHandler": {
"type": "sed do minim",
"name": "non proident"
},
"font_size": 12,
"created": "1975-01-16T13:55:35.997Z",
"created_by": {
"username": "sit esse laborum fugiat magna",
"provenance": "velit mollit pariatur ea irure"
},
"createdVersion": "voluptate incididunt occaecat exercitation",
"last_updated": "2002-09-16T20:13:12.619Z",
"last_updated_by": null,
"lastUpdatedVersion": "adipisicing dolore ut ipsum",
"tags": [
{
"_id": "A5E4727913CafAFBC1430566",
"name": "consequat eu ea",
"description": "pariatur tempor"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/PD1evWPHAUI"
}
],
"migrationVersion": 78732276
}