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": "veniam Lorem Ut"
}
}
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": 13059217.274294704,
"y": 18675288.15653126
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -46275949.93233695,
"y": 90363316.59637061
},
"error_handler": {
"name": "childJob",
"summary": "Ut minim fugiat nisi",
"description": "nisi Excepteur",
"app": "sit",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/MB,/~0/qj/~1/~0/L8O5L/GLte/~1/~0/GN.9/Sg"
},
{
"type": "encryption",
"pointer": "/~0/dljP0+/GiaER1r7lo/~0/ce0/J6/C9szI1zy1,/O8R6/x/~0/~0"
},
{
"type": "encryption",
"pointer": "/K.H0vw+eb/s4eYVGsi2N/~0/oDfkJT/Ft"
},
{
"type": "encryption",
"pointer": "/OC.+K9n+oXF/~0/~0/gs5x/FBL/~1/~1/~1/~1"
}
]
},
"groups": [
{
"name": "in",
"provenance": "dolor ipsum"
}
],
"type": "operation",
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "dolore esse",
"provenance": "irure tempor sint labore in"
},
{
"name": "non officia sunt",
"provenance": "ea"
},
{
"name": "voluptate",
"provenance": "pariatur sit eiusmod magna velit"
},
{
"name": "anim non id pariatur",
"provenance": "in esse pariatur"
}
],
"_id": "af739511-8fd7-47aa-5900-8f9863d4e5b4",
"description": "aute officia",
"errorHandler": null,
"font_size": 12,
"created": "1996-12-01T06:54:44.359Z",
"created_by": null,
"createdVersion": "tempor laboris exercitation irure",
"last_updated": "1967-02-20T09:24:26.904Z",
"last_updated_by": null,
"lastUpdatedVersion": "non",
"tags": [
{
"_id": "caD9480EB7B02FfcA8B4088B",
"name": "ullamco sed ex in voluptate",
"description": "enim dolor Duis"
},
{
"_id": "EeEF643A1F6A3e4813998E34",
"name": "in voluptate esse eiusmod",
"description": "incididunt ullamco veniam labore in"
},
{
"_id": "b62afd10dD6e5DDDE4DC46Df",
"name": "ea magna",
"description": "ut nostrud consectetur dolor id"
},
{
"_id": "AA4e1c2f9Fda6e870bfBc2f4",
"name": "Lorem anim ea proident Ut",
"description": "amet"
},
{
"_id": "fCc06d3EeEA7b73Fe7ba3Cfc",
"name": "in veniam occaecat Duis",
"description": "sed"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/uJOBfR/~1/~1/~1/~0/~0"
}
],
"migrationVersion": 86042065
}