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": "magna pariatur velit"
}
}
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": -83848684.82485813,
"y": 23063233.366279066
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -28252405.481443882,
"y": -66193011.47582419
},
"error_handler": {
"name": "childJob",
"summary": "nostrud",
"description": "dolor",
"app": "dolore aliqua incididunt nisi adipisicing",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/pKcEULG/~0/~0/PgZkC/~0/y7m4Ar/~1/~0/~1"
},
{
"type": "encryption",
"pointer": "/~0/LFbALbFt7S"
},
{
"type": "encryption",
"pointer": "/~1/~1/~1/~1/~0/~1/~1/HatY/~1"
},
{
"type": "encryption",
"pointer": "/~1/~0/MepqBYWG/l3/~1/r3Juwr"
},
{
"type": "encryption",
"pointer": "/~0/XZogNwd./P3sw/kztnu.UaW/~0/NeMYNQGN3/yRZ/5h/~1"
}
]
},
"groups": [
{
"name": "nostrud dolore do",
"provenance": "irure sit nulla eu"
},
{
"name": "esse culpa id quis non",
"provenance": "exercitation et dolore Lorem"
},
{
"name": "aliquip",
"provenance": "in"
},
{
"name": "esse Excepteur",
"provenance": "Ut nisi anim enim"
},
{
"name": "dolore Excepteur qui et",
"provenance": "labore"
}
],
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "sint Lorem",
"provenance": "culpa consectetur ex minim labore"
},
{
"name": "laborum",
"provenance": "magna"
}
],
"_id": "63498153-36e3-ce34-c558-23f3a42ff4f9",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1995-07-07T00:30:44.719Z",
"created_by": null,
"createdVersion": "enim",
"last_updated": "1946-10-16T07:50:02.037Z",
"last_updated_by": {
"username": "laborum",
"provenance": "sed nulla"
},
"lastUpdatedVersion": "esse dolore cillum",
"tags": [
{
"_id": "00dBAA9c0FEC9eEDb81B3049",
"name": "in",
"description": "dolor mollit"
},
{
"_id": "a62e0dad376d988d13B14c3D",
"name": "ipsum ut officia",
"description": "ad qui velit"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/xXzEU+fw,lR/RBy"
},
{
"type": "encryption",
"pointer": "/jO-7uWMqmn+/~0/mMqAV/fQ45eYb"
}
],
"migrationVersion": 82640757
}