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": "ut id pariatur 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": [
{
"name": "aliqua est",
"provenance": "ipsum eu"
},
{
"name": "adipisicing",
"provenance": "labore pariatur sit Duis"
},
{
"name": "culpa sit",
"provenance": "dolore Excepteur irure incididunt"
},
{
"name": "amet",
"provenance": "qui nulla dolor"
}
],
"x": -85983438.58188051,
"y": 43660127.88662523
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "sunt fugiat nostrud exercitation",
"provenance": "ad"
},
{
"name": "eiusmod dolor pariatur ipsum exercitation",
"provenance": "deserunt Lorem amet"
},
{
"name": "elit velit voluptate eu adipisicing",
"provenance": "voluptate"
},
{
"name": "deserunt amet consequat dolore",
"provenance": "magna in"
}
],
"x": 90589043.69135767,
"y": -14644955.353636965
},
"error_handler": {
"name": "childJob",
"summary": "mollit laborum",
"description": "eiusmod aliquip mollit consequat laboris",
"app": "proident incididunt",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~0/~1/~0/l1/~0/r,lmur/sHd2mELZ/l+/yN1T9MXiMt/fd8QR-7/m91Wad4Oree"
},
{
"type": "encryption",
"pointer": "/~0/gYN9/MRdke/YGM+/Na6/F/c"
},
{
"type": "encryption",
"pointer": "/mB9K/~1/euy7M/tygziA9/~0/~0/~0/ugd3FXirNRZ/~1/a9Rft/Vpbw1"
}
]
},
"groups": [
{
"name": "in Excepteur exercitation voluptate",
"provenance": "in"
}
],
"x": 12011452.343866706,
"y": -99575930.80204186,
"type": "operation",
"gridCoordinate": {
"x": -88682074.81530242,
"y": -77421273.5170631
},
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "exercitation",
"provenance": "magna"
},
{
"name": "consequat culpa quis",
"provenance": "enim voluptate irure ex"
},
{
"name": "incididunt occaecat cillum Excepteur",
"provenance": "culpa in sunt dolore"
}
],
"_id": "d773e738-95b7-de5a-ca63-db083d865a53",
"description": null,
"namespace": null,
"errorHandler": null,
"font_size": 12,
"created": "2010-06-15T16:02:44.512Z",
"created_by": {
"username": "proident est officia",
"provenance": "ut esse sint"
},
"createdVersion": "voluptate",
"last_updated": "1962-11-24T12:27:56.689Z",
"last_updated_by": null,
"lastUpdatedVersion": "veniam ad nulla",
"tags": [
{
"_id": "6AADE093D8CF5E0Ae9D5FBea",
"name": "Lorem dolor",
"description": "proident"
}
],
"canvasVersion": 3,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/T/u9we/q.eFy/cFDtOh4/~0/Nq/vH/~0"
},
{
"type": "encryption",
"pointer": "/oZ7MU6ZwiCm/g5UUtNan/afv/~0/nJ4dpFP24h/Mx-Cj/~1/~1/~1/uF45S/~0"
},
{
"type": "encryption",
"pointer": "/sBVsr.x/~1/~0/~0/~1/AQ6C8kQLyp+/GGw"
},
{
"type": "encryption",
"pointer": "/~1/~1/~1/~0"
}
],
"migrationVersion": 22153824
}