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": "et in"
}
}
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": -2203450.647898242,
"y": -38472073.37869278
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -31656328.495392576,
"y": -81161436.24636027
},
"error_handler": {
"name": "childJob",
"summary": "aliquip ipsum",
"description": "mollit",
"app": "quis",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/l4ETbDdmF/ZiW5hXr2ji/k.UvwExjH/~0/MpM/~1/EylomDSZy/fKO-s,HJx9c/A8Qvq/~0/RadKkkbWCL"
},
{
"type": "encryption",
"pointer": "/~1/~0/~0/~1/~0/fD84k2x/~0/aRJ-+zQ/u3j/z0Scu2/~0/MmLJ+GLu,b"
}
]
},
"groups": [
{
"name": "elit sed eu occaecat Excepteur",
"provenance": "est qui do nisi irure"
},
{
"name": "sunt enim",
"provenance": "reprehenderit id ad aliqua"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "reprehenderit ex velit non magna",
"provenance": "pariatur cillum nisi"
},
{
"name": "sint laboris ex et",
"provenance": "reprehenderit enim tempor"
},
{
"name": "sed id fugiat ad",
"provenance": "labore sit"
}
],
"_id": "29aaa291-9ef9-9a4b-29c8-92a8854b0099",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1983-09-09T07:35:20.423Z",
"created_by": {
"username": "Duis aliqua aliquip adipisicing magna",
"provenance": "ipsum"
},
"createdVersion": "ipsum Duis occaecat",
"last_updated": "1969-06-16T09:07:03.419Z",
"last_updated_by": {
"username": "sed in officia laborum",
"provenance": "occaecat id Lorem"
},
"lastUpdatedVersion": "irure dolor occaecat exercitation anim",
"tags": [
{
"_id": "CCeC0de209bb23EAE0caaBFA",
"name": "dolore est id laboris dolor",
"description": "dolor magna ipsum non sunt"
},
{
"_id": "4cCf432cEec5bdAEF7d9590B",
"name": "enim nisi sed",
"description": "voluptate Excepteur"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/~0"
},
{
"type": "encryption",
"pointer": "/~1/tp5RVpT/~0/N6N/~1/CLvzI/YSN/RkFtgvS3/tKzJg/Hwd/~0"
},
{
"type": "encryption",
"pointer": "/BlHDPVE/n/ugX/J,bzXGkbm7/~1/~1/w50/GB5aM/GDwiuSH/BD/~0"
}
],
"migrationVersion": 64442199
}