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": "exercitation tempor laboris"
}
}
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": -85995965.48142992,
"y": -59926906.523372024
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -46234408.30856214,
"y": 45716045.285330415
},
"error_handler": {
"name": "childJob",
"summary": "in commodo tempor",
"description": "irure",
"app": "aliquip anim ea occaecat eu",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/K0J/~0/OJZ3rj9CuK/YJpuM,z2PO"
}
]
},
"groups": [
{
"name": "dolor aliqua culpa Ut laboris",
"provenance": "dolore enim aliqua"
},
{
"name": "dolore culpa",
"provenance": "ipsum"
}
],
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "ex enim Duis",
"provenance": "et dolor aliqua veniam ut"
},
{
"name": "occaecat Ut velit elit sunt",
"provenance": "est"
},
{
"name": "ex dolore commodo",
"provenance": "id ad"
},
{
"name": "tempor dolore aliqua adipisicing in",
"provenance": "elit nisi"
},
{
"name": "aliqua adipisicing",
"provenance": "laborum"
}
],
"_id": "56ccdc89-15e4-6548-bc3c-fcfb1d4e5871",
"description": "occaecat cillum sit anim",
"errorHandler": null,
"font_size": 12,
"created": "2014-12-19T00:57:09.312Z",
"created_by": null,
"createdVersion": "tempor incididunt aliquip exercitation",
"last_updated": "2000-11-30T04:16:09.347Z",
"last_updated_by": null,
"lastUpdatedVersion": "cupidatat et exercitation",
"tags": [
{
"_id": "E22ADCd0CBEEa6DEA67659AC",
"name": "eiusmod occaecat sint consectetur anim",
"description": "dolore pariatur"
},
{
"_id": "F535e32cadd91cF762BBDdC9",
"name": "Lorem proident",
"description": "eiusmod"
},
{
"_id": "044e55d8D92eC30CEA4E45E1",
"name": "pariatur",
"description": "culpa non deserunt"
},
{
"_id": "9AECE74681CAf9B1EC58aBE7",
"name": "incididunt occaecat irure aute amet",
"description": "nisi sint magna Lorem"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/~0/cO"
},
{
"type": "encryption",
"pointer": "/p0b/Q1InYNN/~0/FSu0g8es/vn/YNjmt/~0"
},
{
"type": "encryption",
"pointer": "/~1/~1/mk/Q/~1/~0/cRL/GuO/~0/~0/~1"
}
],
"migrationVersion": 80979788
}