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": "4321abcdef694aa79dae47ad",
"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": 26200244.77835381,
"y": 15189898.593881994
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 46929939.80066255,
"y": -45438132.47828927
},
"error_handler": {
"type": "operation",
"name": "childJob"
}
},
"transitions": {},
"groups": [
{
"name": "dolore Duis elit",
"provenance": "dolor in magna anim cupidatat"
}
],
"_id": "4f8e61b8-5f2b-b07a-7df8-a3f87ef6382d",
"description": "aliqua laboris",
"font_size": 12,
"created": "1945-09-06T21:19:50.306Z",
"created_by": null,
"createdVersion": "sit",
"last_updated": "2000-12-01T05:25:12.715Z",
"last_updated_by": null,
"lastUpdatedVersion": "mollit commodo consequat in anim",
"canvasVersion": 2
}