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": 72536426.47446892,
"y": 97689033.30812228
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -33644135.2143384,
"y": 81004129.21053123
},
"error_handler": {
"type": "operation",
"name": "childJob"
}
},
"transitions": {},
"groups": [
{
"name": "deserunt officia Excepteur ut",
"provenance": "ad magna non voluptate"
},
{
"name": "eiusmod in sunt magna",
"provenance": "qui velit culpa"
},
{
"name": "veniam in consequat",
"provenance": "ad officia enim"
},
{
"name": "esse ut minim commodo",
"provenance": "sint proident aliquip ad ea"
},
{
"name": "non cillum anim occaecat",
"provenance": "quis"
}
],
"_id": "35ccc438-9e6b-a49a-c5c6-c2a37bc1216f",
"description": "laboris",
"errorHandler": null,
"font_size": 12,
"created": "2011-03-11T05:40:00.483Z",
"created_by": null,
"createdVersion": "aliqua Ut do",
"last_updated": "1993-04-27T22:45:20.242Z",
"last_updated_by": null,
"lastUpdatedVersion": "aliquip",
"tags": [
{
"_id": "0Ddfb1ef18c00D553a32640f",
"name": "do amet irure velit veniam",
"description": "incididunt ut"
},
{
"_id": "DFb2bC7f0fef0ce3e3f6E322",
"name": "id Excepteur est ea",
"description": "ut consequat dolor ex"
},
{
"_id": "77E9Ab0622FCEd0E8Ea6A6d0",
"name": "ut incididunt",
"description": "quis ullamco"
},
{
"_id": "00b454bb2D85aa36B6DcDf43",
"name": "culpa sint aute",
"description": "consectetur ut mollit sint veniam"
}
],
"canvasVersion": 1
}
