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": "5cb7b531d06cceb89fd21b1c",
"name": "someWorkflowName",
"type": "ullamco officia cupidatat consequat"
}
}
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": 91608789.36643314,
"y": 25258875.57120274
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -20780691.781352177,
"y": -49783047.71806568
},
"error_handler": {
"name": "childJob",
"summary": "proident sed esse",
"description": "voluptate consectetur ad",
"app": "adipisicing id et aliqua",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/H-E6lr/~0/hhq9ZLK2h+"
},
{
"type": "encryption",
"pointer": "/~1/jMzAN1y/XEfmBEScNY/~1/~1"
},
{
"type": "encryption",
"pointer": "/~0/~0/~0/P6huyH7Oro/pU,MLqfRBw3/QrSmWTbduP/~0/rimGph+SJm/K-HlF/zDY.TGz/FYy47MX-k"
},
{
"type": "encryption",
"pointer": "/bbBugc2/~1/~0/~1"
}
]
},
"groups": [
{
"name": "nisi velit aute incididunt sunt",
"provenance": "consequat"
},
{
"name": "culpa aliquip sit ut",
"provenance": "Lorem sed"
}
],
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "reprehenderit Duis magna sit consectetur",
"provenance": "aliqua voluptate eiusmod id pariatur"
},
{
"name": "laborum fugiat sit",
"provenance": "mollit"
}
],
"_id": "1311406d-d7f9-55f5-0206-fc34e3c9ea96",
"description": null,
"errorHandler": {
"type": "ipsum dolore do",
"name": "minim est laboris quis Excepteur"
},
"font_size": 12,
"created": "2021-07-28T21:51:20.149Z",
"created_by": null,
"createdVersion": "mollit dolor",
"last_updated": "1948-04-26T11:08:02.978Z",
"last_updated_by": {
"username": "in dolore",
"provenance": "Ut laborum"
},
"lastUpdatedVersion": "sunt",
"tags": [
{
"_id": "37c9E34453BB6C5a08dD808d",
"name": "eu Ut",
"description": "deserunt reprehenderit occaecat nisi"
},
{
"_id": "384ff653Ae0EDc937FDc51Ce",
"name": "pariatur",
"description": "amet elit"
},
{
"_id": "F2eed0a4Bc9Db5DcDFc7Ad3E",
"name": "dolore ullamco",
"description": "adipisicing sunt"
},
{
"_id": "edbd45b4fd6Cf8Da6CcB7157",
"name": "officia esse anim exercitation",
"description": "veniam in"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~1/vY22bK6/ujS/s1P//d3U"
},
{
"type": "encryption",
"pointer": "/~1/~0/~0/~0"
},
{
"type": "encryption",
"pointer": "/~1/~0"
},
{
"type": "encryption",
"pointer": "/YwEE/zG+pTUdc5/~1/DZcA/qra/UeLv9RVii/w/vrEi/~1/KeJ/kXyY/uIzLD"
}
],
"migrationVersion": 96812438
}