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": "aute elit fugiat"
}
}
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": "dolor reprehenderit",
"provenance": "nulla enim mollit in magna"
},
{
"name": "id nisi incididunt mollit",
"provenance": "tempor Duis ullamco Excepteur"
},
{
"name": "Lorem cillum incididunt ut",
"provenance": "nisi amet aliquip"
}
],
"x": 59487105.392902195,
"y": -59420303.08198301
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "ullamco mollit ex non",
"provenance": "enim adipisicing dolor"
}
],
"x": 82429903.61347756,
"y": -42947433.00185293
},
"error_handler": {
"name": "childJob",
"summary": "laboris ea est minim anim",
"description": "ut officia",
"app": "eu Duis ad proident",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/K-p0W-rs/~1/Qa/yK/~0"
},
{
"type": "encryption",
"pointer": "/~0"
},
{
"type": "encryption",
"pointer": "/K/~0/~0"
},
{
"type": "encryption",
"pointer": "/~1"
},
{
"type": "encryption",
"pointer": "/H/K/~1/~1/x5uIPhXrg2U"
}
]
},
"groups": [
{
"name": "Lorem irure Duis Excepteur",
"provenance": "consectetur officia exercitation velit"
}
],
"x": -11946735.189653784,
"y": 80712421.53995106,
"type": "operation",
"gridCoordinate": {
"x": 34175246.492124334,
"y": -84859767.81108531
},
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "deserunt ullamco consectetur dolore",
"provenance": "Duis proident incididunt"
}
],
"_id": "73e9633c-b385-dea5-4fcf-7149149bf367",
"description": "Duis",
"errorHandler": {
"type": "eu id ad",
"name": "magna adipisicing"
},
"font_size": 12,
"created": "2005-06-14T17:56:37.164Z",
"created_by": null,
"createdVersion": "Ut",
"last_updated": "1969-01-18T16:47:23.493Z",
"last_updated_by": {
"username": "tempor laboris consectetur dolore",
"provenance": "minim elit"
},
"lastUpdatedVersion": "id ullamco commodo",
"tags": [
{
"_id": "d8437abcF0CeBF33FAEFBa1e",
"name": "in qui Lorem magna tempor",
"description": "laboris"
}
],
"canvasVersion": 3,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/Y3k1dZkEtET"
},
{
"type": "encryption",
"pointer": "/~0/RR2BZvHcZF/~0/VILtHGK/a/~1/x83syg6+kR"
},
{
"type": "encryption",
"pointer": "/~1/~1/~0/f5jhohkau1-/~0/xjjpzP5kP/~1"
},
{
"type": "encryption",
"pointer": "/ltGogumpF"
}
],
"migrationVersion": 40939095
}