Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_builder/export
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
options |
object |
yes |
match a workflow using _id or name or type |
Copied to Clipboard
{
"options": {
"_id": "5cb7b531d06cceb89fd21b1c",
"name": "someWorkflowName",
"type": "automation"
}
}
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",
"examples": [
"someWorkflowName"
]
},
"type": {
"type": "string",
"description": "The type of the workflow",
"examples": [
"automation"
]
}
},
"additionalProperties": false
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
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": 68259800.87087715,
"y": -10882397.5670477
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -90747230.51170799,
"y": -76208068.29840365
},
"error_handler": {
"name": "childJob",
"summary": "dolore officia",
"description": "incididunt in",
"app": "adipisicing ad",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/Fs-uiSG/D/~0"
}
]
},
"groups": [
{
"name": "officia ex voluptate tempor pariatur",
"provenance": "cillum"
},
{
"name": "eiusmod ullamco reprehenderit adipisicing consequat",
"provenance": "consectetur aliqua laborum"
},
{
"name": "enim",
"provenance": "dolore est ad sunt"
},
{
"name": "reprehenderit laboris",
"provenance": "culpa esse incididunt et"
},
{
"name": "culpa elit exercitation anim labore",
"provenance": "et in quis dolor ullamco"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "in ad adipisicing",
"provenance": "ipsum irure"
},
{
"name": "laborum nisi ullamco",
"provenance": "elit aute qui non"
},
{
"name": "exercitation cillum pariatur",
"provenance": "ut dolor"
},
{
"name": "minim in",
"provenance": "Duis"
},
{
"name": "reprehenderit labore do",
"provenance": "tempor commodo reprehenderit dolore quis"
}
],
"_id": "3d27ccab-b715-0fa4-1231-0f3ac544dbe4",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1961-03-11T12:00:13.528Z",
"created_by": null,
"createdVersion": "Ut labore laboris",
"last_updated": "1945-10-25T04:56:29.084Z",
"last_updated_by": null,
"lastUpdatedVersion": "commodo sed",
"tags": [
{
"_id": "a4E16b0edEedDAac9EccEBE9",
"name": "sint mollit Lorem",
"description": "cupidatat culpa Excepteur"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/EtGAEI4E/P/~1/~0/DQe-3lce+7X/Ex0ODe6/~0/~1/~0/dCt4MqJtM/~1"
},
{
"type": "encryption",
"pointer": "/E5Ipk/ZPAXKSt1-j/hG/rBa4MggksR/AHJvYU7/nhDi-Ib,X/eWdfh0eQg/~1/~0/V9rdiAO71,8"
}
]
}