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": 87146942.84977481,
"y": 33232219.340745404
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -55898096.384522855,
"y": -78940920.43279132
},
"error_handler": {
"type": "operation",
"name": "childJob"
}
},
"transitions": {},
"groups": [
{
"name": "in consequat dolore consectetur nulla",
"provenance": "id commodo ex aliqua aliquip"
},
{
"name": "Excepteur in dolore mollit",
"provenance": "eiusmod ad"
},
{
"name": "amet pariatur",
"provenance": "tempor"
},
{
"name": "cupidatat",
"provenance": "nostrud sint velit qui"
},
{
"name": "non tempor",
"provenance": "minim incididunt"
}
],
"_id": "f7911d21-680b-8a38-619c-c48d7767ba73",
"description": "sed",
"errorHandler": {
"type": "anim enim Duis commodo",
"name": "laboris occaecat nulla ad"
},
"font_size": 12,
"created": "1964-04-16T22:25:51.845Z",
"created_by": {
"username": "dolor occaecat dolore proident",
"provenance": "Lorem qui eiusmod dolor"
},
"createdVersion": "Ut",
"last_updated": "1959-08-16T03:21:59.036Z",
"last_updated_by": {
"username": "dolore do tempor",
"provenance": "dolore"
},
"lastUpdatedVersion": "Lorem reprehenderit",
"tags": [
{
"_id": "805ba6ceaa7eeB3C34Ea42B0",
"name": "Lorem anim cillum dolor",
"description": "est fugiat"
},
{
"_id": "c60Fff5f970A80897002Db1D",
"name": "consequat aliquip esse in",
"description": "irure incididunt qui ut sint"
},
{
"_id": "CF6cFDee2ca9AF334bDd1109",
"name": "irure labore Excepteur Lorem",
"description": "ad amet sed culpa"
},
{
"_id": "29feDE90E26cadce8a8aecfF",
"name": "ipsum anim aliqua non",
"description": "amet nisi in cillum"
}
],
"canvasVersion": 2
}