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": -69062461.43597424,
"y": 2600209.0058216453
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 45647187.140610635,
"y": -2151811.214779809
},
"error_handler": {
"name": "childJob",
"summary": "laboris",
"description": "amet irure aliqua cillum",
"app": "ut adipisicing",
"variables": {
"error": ""
},
"groups": [
{
"name": "adipisicing incididunt tempor fugiat id",
"provenance": "incididunt sit"
},
{
"name": "Lorem Ut aliquip",
"provenance": "ea velit"
},
{
"name": "nulla velit ea proident",
"provenance": "ut qui anim ea"
}
],
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "laboris officia sed",
"provenance": "consequat ipsum aliquip est velit"
},
{
"name": "ullamco",
"provenance": "culpa amet dolor in nostrud"
},
{
"name": "veniam Duis dolore",
"provenance": "cillum tempor ex exercitation culpa"
},
{
"name": "adipisicing in",
"provenance": "elit Excepteur"
},
{
"name": "Duis officia pariatur",
"provenance": "veniam pariatur officia"
}
],
"_id": "f340f4d1-9733-ef2f-cdd9-e37d0006e723",
"description": "magna incididunt laborum commodo aliqua",
"errorHandler": null,
"font_size": 12,
"created": "2003-08-11T15:23:29.496Z",
"created_by": {
"username": "ipsum deserunt occaecat proident commodo",
"provenance": "aute qui laborum amet Ut"
},
"createdVersion": "exercitation eu nisi deserunt",
"last_updated": "1965-04-23T08:39:11.877Z",
"last_updated_by": {
"username": "sit",
"provenance": "sit fugiat id labore"
},
"lastUpdatedVersion": "est Lorem dolore eu enim",
"tags": [
{
"_id": "B4B09Ad18bAa7cDF979F5DE5",
"name": "laborum",
"description": "officia non cupidatat"
},
{
"_id": "bcbbd60B823C8EC9D50a94ee",
"name": "mollit cupidatat minim velit",
"description": "ea sunt quis"
},
{
"_id": "A0d9cd358879AE5BAB41cc24",
"name": "ea consequat aliquip nisi velit",
"description": "reprehenderit consequat eu in proident"
},
{
"_id": "5eCbca46fCbB3DeA4F55376e",
"name": "do dolore id nulla",
"description": "proident adipisicing Duis veniam"
}
],
"canvasVersion": 1
}