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": "et sint non"
}
}
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": "eu cillum ullamco ipsum Duis",
"provenance": "non"
},
{
"name": "laboris",
"provenance": "officia"
},
{
"name": "commodo ut magna",
"provenance": "dolor"
},
{
"name": "ut",
"provenance": "minim in sunt"
}
],
"x": -4312488.003165126,
"y": 49871923.497196615
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "nisi",
"provenance": "ad cupidatat dolore"
},
{
"name": "non Ut id labore in",
"provenance": "aliquip pariatur dolore"
}
],
"x": 72324415.31831908,
"y": -9134037.024609268
},
"error_handler": {
"name": "childJob",
"summary": "et ipsum Lorem",
"description": "magna do",
"app": "nisi mollit",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~0/~1/~0/O6F6/g/a+jc/rjjPIb5/Z/~0/oDOkiukeRD/y8"
},
{
"type": "encryption",
"pointer": "/zR-hs6/~0/I73S3GPB6/pX34/BX0k7S/~1/~0/~1/fgm2s7s1uh/~0/y.5O3cHKfUQ"
}
]
},
"groups": [
{
"name": "eu velit",
"provenance": "ea"
},
{
"name": "do veniam Lorem",
"provenance": "minim dolore aliquip in"
},
{
"name": "labore",
"provenance": "fugiat dolor"
},
{
"name": "voluptate culpa occaecat ipsum",
"provenance": "dolore ut quis"
},
{
"name": "enim aliqua",
"provenance": "anim culpa"
}
],
"x": -57070032.090522416,
"y": -18038183.747849956,
"type": "operation",
"gridCoordinate": {
"x": 35442847.49089113,
"y": 72768856.91967764
},
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "cillum voluptate dolor mollit culpa",
"provenance": "consectetur reprehenderit sit laborum ipsum"
},
{
"name": "consequat eu aliqua sunt veniam",
"provenance": "in est ad mollit"
},
{
"name": "sunt Lorem in veniam",
"provenance": "irure"
},
{
"name": "qui est enim aliquip nisi",
"provenance": "tempor in"
}
],
"_id": "7275a20d-292f-6c6b-56a8-94ed67d3d98d",
"description": "ut reprehenderit minim proident cillum",
"errorHandler": null,
"font_size": 12,
"created": "1997-07-11T06:25:11.447Z",
"created_by": null,
"createdVersion": "deserunt culpa fugiat nisi in",
"last_updated": "1984-11-28T20:36:35.727Z",
"last_updated_by": null,
"lastUpdatedVersion": "do Excepteur eiusmod",
"tags": [
{
"_id": "ED91dEC3892CdACacb5DAF30",
"name": "amet occaecat dolore enim",
"description": "veniam id"
},
{
"_id": "4Dd1abaf236CeE59E4BBA1c7",
"name": "in",
"description": "Excepteur"
},
{
"_id": "f23F077D76b4bBf59Fca6F23",
"name": "consequat dolor",
"description": "dolore"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~1/s/~0/~1/wgoler/~0/~1/MC"
}
],
"migrationVersion": 44614884
}