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": -41337912.692647286,
"y": -67048516.949972376
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -84280947.74739376,
"y": -45436961.28702881
},
"error_handler": {
"type": "operation",
"name": "childJob"
}
},
"transitions": {},
"groups": [
{
"name": "do",
"provenance": "pariatur ullamco qui nisi ipsum"
}
],
"_id": "ac3fcbc1-213a-2e2f-3449-96c26dc5c718",
"description": "in aliquip ad cillum",
"errorHandler": {
"type": "ut in",
"name": "id"
},
"font_size": 12,
"created": "1963-06-15T00:34:27.885Z",
"created_by": null,
"createdVersion": "anim",
"last_updated": "1957-10-02T14:17:28.725Z",
"last_updated_by": {
"username": "sed officia",
"provenance": "laboris"
},
"lastUpdatedVersion": "cillum",
"tags": [
{
"_id": "E4Fa5C5bEdaADa3dD4B36fBE",
"name": "pariatur labore",
"description": "pariatur in Lorem"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/f,kwx/~1/ASH"
}
]
}