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 deserunt"
}
}
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": 33081664.239332646,
"y": 88118751.86557865
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -78339268.49556336,
"y": 53026660.03263074
},
"error_handler": {
"name": "childJob",
"summary": "in dolor non",
"description": "culpa sit fugiat veniam",
"app": "dolor aute Duis",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~1/~1/qoUW/~0/P/vuLxSm"
},
{
"type": "encryption",
"pointer": "/u/~0/A5/~1/~0/~1/Qe/~1/njCa/~1/vvp0+EN9AW"
},
{
"type": "encryption",
"pointer": "/~0/JAa/~0/KPtEiY,5N3/~0/~1/~0/vW.oaSKXW/~1/xrnWPR"
},
{
"type": "encryption",
"pointer": "/~1/~0/~0/c6Fg/q/XE+Dqcywt/G2/o4/D-XPb/qsL6czeDFp/F/~1/~0"
}
]
},
"groups": [
{
"name": "officia",
"provenance": "velit"
},
{
"name": "eu aliqua ut",
"provenance": "in culpa anim nisi"
},
{
"name": "exercitation sunt",
"provenance": "sed reprehenderit ipsum ullamco"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "do cillum magna",
"provenance": "voluptate ut officia"
}
],
"_id": "f9393669-de53-55c7-bc7b-41be7cfb6acc",
"description": "magna est consequat",
"errorHandler": null,
"font_size": 12,
"created": "1949-05-26T02:23:02.996Z",
"created_by": {
"username": "culpa reprehenderit",
"provenance": "Excepteur aliquip"
},
"createdVersion": "fugiat",
"last_updated": "1966-04-24T10:25:18.681Z",
"last_updated_by": {
"username": "non fugiat Excepteur",
"provenance": "ut id"
},
"lastUpdatedVersion": "dolor in in dolore Lorem",
"tags": [
{
"_id": "e2aEbDcffaaaeeEBc2FBA6D9",
"name": "Duis elit laborum labore dolor",
"description": "mollit laboris esse et"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/gCDrF2w/V"
},
{
"type": "encryption",
"pointer": "/~1"
},
{
"type": "encryption",
"pointer": "/Gw2"
},
{
"type": "encryption",
"pointer": "/OoP.w1pnvm/~0/~0/LbIeLz.Myym/n,uyY1nzla/~1/GJ+lP0BC/QT7/BFJXyDj1i/~0/~1"
},
{
"type": "encryption",
"pointer": "/~0/R3qBueyp/u14C-EB"
}
],
"migrationVersion": 58775379
}