Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_builder/export
Roles
admin
apiread
Parameters
Details Example Schema
Name
Type
Required
Description
options
object
yes
match a workflow using _id or name. Type may be included as an additional filter when using name.
Copied to Clipboard
{
"options": {
"_id": "4321abcdef694aa79dae47ad",
"name": "someWorkflowName",
"type": "nulla incididunt ex in"
}
}
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. When provided, 'type' can also be specified for additional filtering.",
"examples": [
"someWorkflowName"
]
},
"type": {
"type": "string",
"description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering."
}
},
"required": [
"_id",
"name"
],
"oneOf": [
{
"required": [
"_id"
]
},
{
"required": [
"name"
]
}
],
"additionalProperties": false
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
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": -63610889.85614489,
"y": -97193328.27261904
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 46355629.435082555,
"y": 68622251.35684928
},
"error_handler": {
"name": "childJob",
"summary": "esse in dolor in",
"description": "sed ullamco pariatur Lorem enim",
"app": "ad ipsum",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/uJP/~0"
},
{
"type": "encryption",
"pointer": "/~0/vTg4bi.-/OUEXK4/IOaaClgO4A/TMAleH9Ji/~1/~0/~0/O7,98"
},
{
"type": "encryption",
"pointer": "/~1/~0/r9ADAR/rMZc3m35i.-/~1/~1/~1"
},
{
"type": "encryption",
"pointer": "/~1/~1/tspExV/D167rHTolOJ/kMyPAhr"
}
]
},
"groups": [
{
"name": "occaecat cillum et",
"provenance": "sit et ipsum"
},
{
"name": "in",
"provenance": "aliquip incididunt qui do"
},
{
"name": "nulla sed in esse elit",
"provenance": "irure nostrud enim"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "est voluptate dolore esse",
"provenance": "pariatur quis incididunt ullamco"
},
{
"name": "aliqua",
"provenance": "cupidatat cillum quis culpa"
}
],
"_id": "9b15aeaf-450f-3044-8ac2-b4657734531f",
"description": "ullamco sint pariatur qui",
"errorHandler": null,
"font_size": 12,
"created": "2017-12-09T18:42:58.668Z",
"created_by": {
"username": "reprehenderit labore in",
"provenance": "deserunt laboris"
},
"createdVersion": "ullamco enim laboris",
"last_updated": "1976-09-11T06:12:59.424Z",
"last_updated_by": null,
"lastUpdatedVersion": "deserunt laborum eiusmod laboris amet",
"tags": [
{
"_id": "6d783caFD0Fda016B924edfE",
"name": "consectetur magna sint officia",
"description": "non reprehenderit dolor"
},
{
"_id": "0E0FabFfdA14709D1a7E7DCd",
"name": "consequat cillum ullamco",
"description": "adipisicing"
},
{
"_id": "2b76Ae4e6320C3f899abB9fC",
"name": "est labore",
"description": "consequat Duis"
},
{
"_id": "C4C9EfA9BaD4dEdF506D6fEd",
"name": "enim in",
"description": "ex ullamco anim qui"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/~1"
},
{
"type": "encryption",
"pointer": "/IBO2uWD/bozx5/Yw2MlD/~1/w,8ohhaf-7/~0/~0/ox6iG8Q"
}
],
"migrationVersion": 32156614
}