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": -20349918.0027308,
"y": 31001229.56376122
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 66001417.12001485,
"y": 99600603.72169104
},
"error_handler": {
"name": "childJob",
"summary": "in ad adipisicing consequat mollit",
"description": "ullamco laboris deserunt",
"app": "est labore voluptate amet",
"variables": {
"error": ""
},
"groups": [
{
"name": "ex",
"provenance": "voluptate minim et Ut est"
},
{
"name": "incididunt",
"provenance": "anim id occaecat sunt consectetur"
}
],
"type": "operation",
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "commodo amet aute irure do",
"provenance": "dolore culpa est laborum ex"
},
{
"name": "ut sunt elit nisi in",
"provenance": "ea"
},
{
"name": "aliqua officia sit sed enim",
"provenance": "aute incididunt ad elit"
},
{
"name": "Duis Excepteur elit",
"provenance": "magna exercitation Duis"
},
{
"name": "Duis in",
"provenance": "mollit eiusmod deserunt"
}
],
"_id": "12606df3-9294-89ef-d336-440a8569ef8b",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1964-04-15T15:40:55.773Z",
"created_by": {
"username": "adipisicing Lorem nisi",
"provenance": "dolor adipisicing dolore anim"
},
"createdVersion": "in sint et",
"last_updated": "1970-01-18T22:48:22.43Z",
"last_updated_by": {
"username": "magna sint",
"provenance": "consequat esse tempor pariatur"
},
"lastUpdatedVersion": "Lorem dolore anim Excepteur",
"tags": [
{
"_id": "e529e1c97adA0298696A9ACD",
"name": "deserunt pariatur minim ipsum in",
"description": "sed aliqua magna"
},
{
"_id": "b07bcFbca69fAa4EBa10576d",
"name": "culpa sit exercitation",
"description": "irure ea"
},
{
"_id": "2CdcE00FdfD07f3CfC150162",
"name": "cupidatat dolore est do sed",
"description": "quis"
},
{
"_id": "c6EdeffaD6Bd6d5d6639B6Ae",
"name": "ea consequat",
"description": "labore"
},
{
"_id": "95Ca0ce3A25f522Bfeb9d7E0",
"name": "eiusmod dolore",
"description": "veniam cupidatat minim eu"
}
],
"canvasVersion": 2
}