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": "incididunt irure cupidatat"
}
}
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": "minim sit Ut",
"provenance": "aliqua consectetur"
}
],
"x": -8289888.256335318,
"y": -41425120.31011498
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "exercitation nisi Lorem ut dolor",
"provenance": "ipsum labore dolore Lorem esse"
},
{
"name": "proident adipisicing Lorem",
"provenance": "nostrud do"
},
{
"name": "magna dolor pariatur",
"provenance": "do mollit deserunt"
}
],
"x": 26926914.786962137,
"y": 3969128.7028360963
},
"error_handler": {
"name": "childJob",
"summary": "enim",
"description": "officia Lorem Ut culpa labore",
"app": "voluptate enim reprehenderit",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~0"
},
{
"type": "encryption",
"pointer": "/t-BeW9TrQWe/kG/~0/~0/w5B-sQD-fpl"
}
]
},
"groups": [
{
"name": "sit aliqua fugiat eu officia",
"provenance": "ut in"
},
{
"name": "sed commodo ad sunt",
"provenance": "minim Duis ad est occaecat"
}
],
"x": -45745104.648725435,
"y": -7156716.414995179,
"type": "operation",
"gridCoordinate": {
"x": -94488494.31816351,
"y": -61136446.68442588
},
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "id",
"provenance": "tempor"
},
{
"name": "ipsum esse Ut nostrud consequat",
"provenance": "Duis"
}
],
"_id": "d249b825-0123-f216-9f32-8f902c256027",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1948-06-01T07:49:47.416Z",
"created_by": null,
"createdVersion": "aute cupidatat",
"last_updated": "1996-08-20T15:24:11.425Z",
"last_updated_by": null,
"lastUpdatedVersion": "in dolore Excepteur",
"tags": [
{
"_id": "e2c572b8fa3e6cb95eeB8f8d",
"name": "reprehenderit veniam commodo non aute",
"description": "eu elit nulla"
},
{
"_id": "e8aa6b8CA9b2d74D17f44B14",
"name": "in deserunt dolor",
"description": "irure"
},
{
"_id": "A8Cd1cFd697594b2bE83faA0",
"name": "dolor do adipisicing",
"description": "officia irure tempor ullamco"
},
{
"_id": "F79bd1E774F66ce4eC4cF4a6",
"name": "ut commodo veniam",
"description": "laborum nisi"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/P-x,UUnA/adlN8/~0"
},
{
"type": "encryption",
"pointer": "/~1/SnXp/~0/~1/SYcha"
}
],
"migrationVersion": 41154736
}