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 cillum"
}
}
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": -66692907.86105901,
"y": -37741372.21602105
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -85712273.30135298,
"y": -25694853.60911213
},
"error_handler": {
"name": "childJob",
"summary": "commodo",
"description": "cupidatat sit dolore",
"app": "sint officia consectetur",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/I0O9/~1/C8R1N/we/z/~1/~1/I2/~1"
},
{
"type": "encryption",
"pointer": "/gesygaAP"
},
{
"type": "encryption",
"pointer": "/~0/v6y/J,KQ9J/~1/~0"
},
{
"type": "encryption",
"pointer": "/P7z6/W/~1/V..xgSHRs/WC/~1"
},
{
"type": "encryption",
"pointer": "/~0/IV/~1/~0/fwshQKyTWK/OTPJL9q2/kY/b/~0/~1/~1"
}
]
},
"groups": [
{
"name": "quis mollit",
"provenance": "est enim"
},
{
"name": "qui dolore",
"provenance": "sunt Ut ullamco reprehenderit"
},
{
"name": "aute et incididunt",
"provenance": "fugiat in nisi velit ea"
},
{
"name": "anim sunt",
"provenance": "Lorem ad magna quis deserunt"
}
],
"type": "operation",
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "dolor et do ullamco elit",
"provenance": "aute"
},
{
"name": "minim est sunt",
"provenance": "dolor qui"
}
],
"_id": "6028f7a1-23e7-10e1-5d29-adf87be4a88d",
"description": "eu velit",
"errorHandler": null,
"font_size": 12,
"created": "1946-10-02T06:06:24.356Z",
"created_by": null,
"createdVersion": "enim",
"last_updated": "1977-10-10T05:37:57.837Z",
"last_updated_by": null,
"lastUpdatedVersion": "exercitation aute ullamco",
"tags": [
{
"_id": "Fb3A3a265Ddf615E0b07e8AF",
"name": "tempor eiusmod",
"description": "ad non sunt"
},
{
"_id": "Ab97da71BF3AEab9cdAFd9aF",
"name": "commodo",
"description": "ad"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~0/~1/xzA,NECYk/~0"
},
{
"type": "encryption",
"pointer": "/~1/jVD6A//M/jAx/~1/Ky/UqSvhMxAc.9/exP2Coq/~0/~1/~0"
},
{
"type": "encryption",
"pointer": "/z/OXc72z/F/~0/~1/~0/~1/~0/HNfA/~1/~1/~1"
},
{
"type": "encryption",
"pointer": "/O1vgOf/Um4IB2f"
},
{
"type": "encryption",
"pointer": "/Y.K/RVrARml+4m/b4SxYdX1/~1/A/L"
}
],
"migrationVersion": 87798398
}