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": 18713800.0408182,
"y": -25573508.863119036
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -72679787.81251241,
"y": -8268282.596992195
},
"error_handler": {
"name": "childJob",
"summary": "cupidatat do",
"description": "ex officia mollit",
"app": "ex",
"variables": {
"error": ""
},
"groups": [
{
"name": "ea sed",
"provenance": "laborum dolore irure ad aliqua"
},
{
"name": "sunt",
"provenance": "cillum in est"
},
{
"name": "do et reprehenderit",
"provenance": "Lorem deserunt commodo nisi tempor"
},
{
"name": "deserunt enim exercitation cupidatat",
"provenance": "irure magna fugiat nisi dolor"
}
],
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "ut fugiat",
"provenance": "laboris"
},
{
"name": "laborum enim amet laboris",
"provenance": "voluptate esse deserunt"
},
{
"name": "laboris qui incididunt",
"provenance": "dolore qui veniam sunt"
}
],
"_id": "bb86ccca-8b6a-0cfa-6300-639c8822da14",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1970-08-03T08:21:37.687Z",
"created_by": null,
"createdVersion": "sit exercitation dolor",
"last_updated": "1984-02-02T18:17:41.467Z",
"last_updated_by": null,
"lastUpdatedVersion": "occaecat sed do exercitation ea",
"tags": [
{
"_id": "6Efde2d95dA4fBEd388ba1c8",
"name": "sed enim esse",
"description": "est tempor nostrud"
},
{
"_id": "D676bc1B8Bb9eD28eae15Ab1",
"name": "Duis nisi cillum elit",
"description": "occaecat"
}
],
"canvasVersion": 1
}