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": -67815884.15356721,
"y": 85422044.50259435
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 32638340.053248346,
"y": 16278347.797894895
},
"error_handler": {
"name": "childJob",
"summary": "Ut irure velit eiusmod sit",
"description": "ut reprehenderit Lorem laborum Duis",
"app": "quis est",
"variables": {
"error": ""
},
"groups": [
{
"name": "Ut sunt nostrud",
"provenance": "ullamco"
},
{
"name": "et ea",
"provenance": "Duis eiusmod"
},
{
"name": "dolore cillum",
"provenance": "veniam"
},
{
"name": "consequat dolore nostrud velit Lorem",
"provenance": "culpa nostrud"
}
],
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "Lorem ut consequat esse",
"provenance": "ad officia est ea labore"
},
{
"name": "culpa Excepteur consectetur Lorem",
"provenance": "ipsum amet"
}
],
"_id": "06e7dcc8-26bd-62dc-d74c-1a209d3eea38",
"description": "nisi occaecat veniam non",
"errorHandler": null,
"font_size": 12,
"created": "1995-02-26T11:55:32.331Z",
"created_by": {
"username": "dolore fugiat quis",
"provenance": "ullamco esse dolore amet"
},
"createdVersion": "pariatur tempor",
"last_updated": "1954-08-30T21:21:11.223Z",
"last_updated_by": null,
"lastUpdatedVersion": "cillum labore enim",
"tags": [
{
"_id": "D0CD9499cFDc879e6909b0BA",
"name": "magna in in",
"description": "amet ut minim in"
},
{
"_id": "B87968cCd2E14DeF7c8D80aB",
"name": "ea Lorem",
"description": "ex exercitation ea eu"
},
{
"_id": "7e4DAbDe550BB5a1242e49Cf",
"name": "irure laboris dolor proident fugiat",
"description": "occaecat sunt magna"
},
{
"_id": "52C21EeFabEDC1374E6BebA8",
"name": "sunt qui fugiat esse commodo",
"description": "in ut labore ea velit"
}
],
"canvasVersion": 1
}