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": "incididunt labore"
}
}
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": 28641791.48530659,
"y": 44078561.59793919
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -91468270.37493673,
"y": -13655467.151147291
},
"error_handler": {
"name": "childJob",
"summary": "non amet dolor anim",
"description": "Ut exercitation ipsum ut do",
"app": "occaecat ad ex dolor nostrud",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~0/J9"
},
{
"type": "encryption",
"pointer": "/jSCE"
},
{
"type": "encryption",
"pointer": "/~1/~1/~0/YNLbz2KC76/Lw0GmLvE9/~0/C8Im/~0/~1"
},
{
"type": "encryption",
"pointer": "/~1/~0/RSuum/EHPu.8lvywV/~0/~0/O4X/heOsjF"
}
]
},
"groups": [
{
"name": "quis",
"provenance": "sed ipsum"
},
{
"name": "dolore nisi",
"provenance": "est aliqua nulla"
},
{
"name": "proident",
"provenance": "elit cillum fugiat Lorem"
},
{
"name": "dolor veniam",
"provenance": "nisi do laboris irure officia"
}
],
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "id cillum commodo incididunt",
"provenance": "velit"
},
{
"name": "Excepteur laboris",
"provenance": "dolor"
}
],
"_id": "d2d80fac-6d10-df61-1157-7f526b23abe5",
"description": "sit dolor",
"errorHandler": null,
"font_size": 12,
"created": "1968-09-13T20:24:48.175Z",
"created_by": null,
"createdVersion": "aliqua enim",
"last_updated": "1994-09-08T01:01:11.69Z",
"last_updated_by": null,
"lastUpdatedVersion": "laboris qui deserunt",
"tags": [
{
"_id": "579b2A7bC42BfEe18C5aE9B0",
"name": "nisi ea veniam",
"description": "sint aliquip dolore"
},
{
"_id": "BCDDcEf638AcF7DbBEd2e32a",
"name": "sed",
"description": "aliquip nisi laboris dolor"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/~0"
},
{
"type": "encryption",
"pointer": "/~0/~1/~0/Vp/~1/~0/OJMOs/~1/~1/~1"
},
{
"type": "encryption",
"pointer": "/~1/G5.sYn/VyAl.I"
}
],
"migrationVersion": 1795871
}