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": -10694342.584390089,
"y": -87654210.68856663
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -6438088.398589551,
"y": -36924509.89488605
},
"error_handler": {
"type": "operation",
"name": "childJob"
}
},
"transitions": {},
"groups": [
{
"name": "id ullamco magna sit",
"provenance": "consequat do"
},
{
"name": "cillum voluptate pariatur adipisicing",
"provenance": "proident eiusmod exercitation et est"
},
{
"name": "ullamco est occaecat consequat",
"provenance": "sunt"
},
{
"name": "dolore in consectetur",
"provenance": "sed cillum minim"
},
{
"name": "occaecat ipsum",
"provenance": "tempor dolore"
}
],
"_id": "b598c0f7-0189-7833-26c4-612abd677773",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1954-01-31T09:01:35.52Z",
"created_by": null,
"createdVersion": "amet aute exercitation dolore enim",
"last_updated": "1998-10-26T15:28:51.051Z",
"last_updated_by": null,
"lastUpdatedVersion": "anim consectetur",
"tags": [
{
"_id": "3bF5f06aEFcCd9f30fE3bA13",
"name": "eiusmod",
"description": "dolore ullamco dolore nostrud"
},
{
"_id": "aCdcfDEf87aec8D53ab0cac3",
"name": "ea",
"description": "dolore ipsum"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/dPhv/Uv,/Xk8/~0/S/yVLYL"
},
{
"type": "encryption",
"pointer": "/I/xBv+6MD/~1/~0"
}
]
}
