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": -40299666.95992049,
"y": 21663469.50845717
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -94263722.59473786,
"y": -98048456.55787022
},
"error_handler": {
"name": "childJob",
"summary": "Lorem pariatur anim",
"description": "officia proident ullamco",
"app": "ea in",
"variables": {
"error": ""
},
"groups": [
{
"name": "irure nisi",
"provenance": "eu adipisicing"
}
],
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "id cillum occaecat voluptate sint",
"provenance": "dolor"
}
],
"_id": "e5386f39-0582-abf6-608c-874a75d1e0b0",
"description": "occaecat laboris",
"errorHandler": null,
"font_size": 12,
"created": "1959-03-24T20:54:56.413Z",
"created_by": null,
"createdVersion": "Ut minim sit do dolor",
"last_updated": "1977-02-06T08:01:57.52Z",
"last_updated_by": null,
"lastUpdatedVersion": "cillum amet aute ut",
"tags": [
{
"_id": "634eBA2faeA6390bF7ccdAde",
"name": "magna exercitation",
"description": "ea proident eu"
},
{
"_id": "608ee9EfE7B2b68DFED82cC5",
"name": "ex veniam commodo",
"description": "consequat"
},
{
"_id": "08B6dbF7eEE4bdFCf9d7EA5C",
"name": "enim fugiat ut",
"description": "occaecat ut"
},
{
"_id": "f1ADb107C052d1C75Fa5be4f",
"name": "labore mollit magna",
"description": "ipsum Excepteur minim et"
}
],
"canvasVersion": 2
}