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": "4321abcdef694aa79dae47ad",
"name": "someWorkflowName",
"type": "pariatur consequat Lorem"
}
}
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": [
{
"name": "ut reprehenderit",
"provenance": "velit occaecat irure magna ullamco"
},
{
"name": "dolore consectetur",
"provenance": "adipisicing"
},
{
"name": "velit cillum magna",
"provenance": "officia voluptate ut"
},
{
"name": "veniam Duis exercitation in et",
"provenance": "ut"
}
],
"x": -41997653.30944936,
"y": -89655642.13367276
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "amet ad esse",
"provenance": "sunt consectetur"
}
],
"x": -459996.33468811214,
"y": 95678542.58133605
},
"error_handler": {
"name": "childJob",
"summary": "in sunt cillum dolore Excepteur",
"description": "ipsum",
"app": "eiusmod aliqua ullamco cupidatat irure",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/rOnIu/ccZHr/~1/CI1R/~0"
},
{
"type": "encryption",
"pointer": "/~0/EJijr/hh+G.4E"
}
]
},
"groups": [
{
"name": "aliqua",
"provenance": "dolor"
},
{
"name": "deserunt fugiat reprehenderit nisi Lorem",
"provenance": "velit laborum mollit"
}
],
"x": -6544243.144031331,
"y": 32340598.951173097,
"type": "operation",
"gridCoordinate": {
"x": -17705202.484289333,
"y": 25571626.38216877
},
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "nisi nulla qui",
"provenance": "voluptate"
},
{
"name": "in labore pariatur dolor",
"provenance": "mollit"
},
{
"name": "exercitation eu sint aliqua reprehenderit",
"provenance": "ea pariatur nulla anim"
},
{
"name": "ullamco consequat officia",
"provenance": "dolor nulla adipisicing"
},
{
"name": "ut",
"provenance": "dolore laborum"
}
],
"_id": "31bb9eab-63d3-a882-6a5c-78002af8cff6",
"description": "in aliquip exercitation ex fugiat",
"errorHandler": {
"type": "dolore irure ad pariatur",
"name": "est amet nostrud in sed"
},
"font_size": 12,
"created": "1972-04-18T14:25:30.585Z",
"created_by": null,
"createdVersion": "laborum sed",
"last_updated": "1970-02-15T11:35:29.34Z",
"last_updated_by": {
"username": "sint cillum proident in",
"provenance": "id enim"
},
"lastUpdatedVersion": "in irure",
"tags": [
{
"_id": "F1455Cdd6a50Be1Ae7Ba4ab9",
"name": "in eu",
"description": "do est consequat Ut cupidatat"
}
],
"canvasVersion": 3,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/DJ5vZoJRD/~1/Nx//An.,CU23/~0/JOkMf,bI+tE"
},
{
"type": "encryption",
"pointer": "/~1/~1/SLJXWBNc/~1/qj/~0/~1/~0/Tnr-JS5YYAb/~1"
},
{
"type": "encryption",
"pointer": "/v/Dh3/~1/~1/~1/~0/~1/~1"
},
{
"type": "encryption",
"pointer": "/tV9YW/~1/~0/~1/gCCi3c6HbU/~0/UUC.c/~0/~1"
}
],
"migrationVersion": 29648726
}