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": "id ex commodo 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": [],
"x": 31722264.656590715,
"y": 52678034.446603835
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 38744713.49248624,
"y": -1685191.831089124
},
"error_handler": {
"name": "childJob",
"summary": "cillum aliquip nisi labore",
"description": "sed proident nostrud dolore",
"app": "do esse incididunt",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~0/yGSQZM/~0/HESX4G/WUl"
},
{
"type": "encryption",
"pointer": "/phb/~0"
},
{
"type": "encryption",
"pointer": "/qvrpsz/~1"
},
{
"type": "encryption",
"pointer": "/~1/~0/TrPquLQ76k/WjstjO,VWA4/rLH-ej8/Y71a/~1/~1/dr4/1/~1"
}
]
},
"groups": [
{
"name": "voluptate anim officia velit esse",
"provenance": "fugiat"
},
{
"name": "nulla anim sit exercitation",
"provenance": "dolor anim voluptate enim cillum"
},
{
"name": "id dolore",
"provenance": "irure"
},
{
"name": "dolore proident",
"provenance": "eiusmod"
}
],
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "dolor incididunt adipisicing",
"provenance": "velit dolor nostrud officia mollit"
},
{
"name": "eu velit cillum consectetur",
"provenance": "amet ea"
}
],
"_id": "2b543b2e-d172-be76-2e46-41ef188970ed",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1946-06-14T00:07:07.122Z",
"created_by": null,
"createdVersion": "pariatur velit labore",
"last_updated": "1995-03-27T03:14:30.915Z",
"last_updated_by": null,
"lastUpdatedVersion": "proident sit pariatur",
"tags": [
{
"_id": "f8FBe4E89aA6eEd63105AAcB",
"name": "in",
"description": "et proident non Ut dolor"
},
{
"_id": "018489DdE6abDDc5BF07c35c",
"name": "voluptate quis id reprehenderit",
"description": "ea dolor esse"
},
{
"_id": "e3C94a6E2Cc91f89EEaeBCdf",
"name": "cupidatat do dolore fugiat veniam",
"description": "voluptate Ut"
},
{
"_id": "Bfc09a865f77A60EcAF04044",
"name": "ut anim culpa",
"description": "nostrud Lorem"
},
{
"_id": "9D13E69eCcB818DA276e2689",
"name": "sit cillum ipsum sint in",
"description": "exercitation"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/m9/SRXV47/~0/~0/Z0ZpB"
},
{
"type": "encryption",
"pointer": "/~0/~0/q0EkmObb/W"
}
],
"migrationVersion": 11362353
}