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": "veniam magna"
}
}
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": [
{
"name": "sit",
"provenance": "esse ipsum"
},
{
"name": "esse",
"provenance": "sed qui"
},
{
"name": "sint id amet esse",
"provenance": "dolore culpa"
}
],
"x": 82794639.89316204,
"y": 34233494.676599145
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "qui",
"provenance": "veniam culpa minim"
},
{
"name": "aliqua exercitation ad quis",
"provenance": "magna sint"
}
],
"x": -85004353.14465657,
"y": 82040240.04428008
},
"error_handler": {
"name": "childJob",
"summary": "ad et pariatur dolor dolor",
"description": "fugiat Duis ea ullamco irure",
"app": "dolor incididunt dolore non eiusmod",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/aK+Llb,b9/T9/r,/VePrd1S8LS/uT/Z+Vjr+y/~0"
},
{
"type": "encryption",
"pointer": "/FyQHG/~1/SDt/~0/ev/~0/g/T43/~0/~0/s84w9"
}
]
},
"groups": [
{
"name": "dolor",
"provenance": "do"
}
],
"x": 13694979.776240677,
"y": -90624872.64994687,
"type": "operation",
"gridCoordinate": {
"x": -83640249.5950277,
"y": -524374.3004907072
},
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "voluptate commodo",
"provenance": "Excepteur eu proident minim velit"
},
{
"name": "in minim",
"provenance": "velit in"
}
],
"_id": "1f6fc297-965e-079f-add5-33aef10684ea",
"description": null,
"errorHandler": {
"type": "reprehenderit proident",
"name": "culpa nulla"
},
"font_size": 12,
"created": "1967-06-21T04:05:12.27Z",
"created_by": null,
"createdVersion": "adipisicing id in ad dolore",
"last_updated": "1996-01-02T01:01:19.971Z",
"last_updated_by": {
"username": "in fugiat",
"provenance": "Lorem cillum laborum elit"
},
"lastUpdatedVersion": "voluptate qui aliqua",
"tags": [
{
"_id": "26997ae040cBec41Ac5eA468",
"name": "commodo id occaecat",
"description": "occaecat do ullamco aliquip"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/un"
},
{
"type": "encryption",
"pointer": "/~1/Sf/~1"
},
{
"type": "encryption",
"pointer": "/XGZ6egv/dbDMP/~0/thEiTXD4/~0/bCo13EESw/F/eEV/~1/o,wFSjG5"
}
],
"migrationVersion": 40555419
}