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": "sunt"
}
}
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": 99649207.28514692,
"y": 30647535.87581244
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 30847484.39953348,
"y": -92318560.7900257
},
"error_handler": {
"name": "childJob",
"summary": "consectetur dolor fugiat incididunt",
"description": "elit consectetur esse cupidatat in",
"app": "in",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~0/fSQjwDQt5/~1/~0/~1/qHx-NUP/~1/~0/JV74"
}
]
},
"groups": [
{
"name": "ipsum laboris cupidatat",
"provenance": "id do sit eu"
},
{
"name": "irure non aute commodo",
"provenance": "mollit dolor ea"
},
{
"name": "Ut eu magna",
"provenance": "officia ipsum deserunt elit quis"
},
{
"name": "est irure",
"provenance": "voluptate"
},
{
"name": "mollit ullamco incididunt nisi veniam",
"provenance": "nostrud sed"
}
],
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "non eiusmod dolore consectetur ad",
"provenance": "officia occaecat aute Lorem aliquip"
},
{
"name": "minim ad",
"provenance": "officia eu incididunt ea qui"
},
{
"name": "in fugiat",
"provenance": "ea nostrud"
},
{
"name": "Excepteur esse aliquip dolor",
"provenance": "in"
},
{
"name": "ad",
"provenance": "sit ea dolore elit reprehenderit"
}
],
"_id": "552f6b6b-a185-c9a8-ee06-ef02c0258d10",
"description": null,
"errorHandler": {
"type": "Ut pariatur est cillum",
"name": "aliquip in incididunt quis"
},
"font_size": 12,
"created": "1964-06-06T08:57:53.689Z",
"created_by": {
"username": "reprehenderit eu",
"provenance": "minim"
},
"createdVersion": "Excepteur",
"last_updated": "2014-10-22T12:07:22.698Z",
"last_updated_by": null,
"lastUpdatedVersion": "dolore in Excepteur magna",
"tags": [
{
"_id": "eaf4e186E9A6861Aaec0cdAA",
"name": "sunt veniam ea minim",
"description": "consequat dolor enim culpa et"
},
{
"_id": "96C32387dEb8B952e950e2Df",
"name": "fugiat enim ad consectetur",
"description": "incididunt minim"
},
{
"_id": "EBDFE7b22eB2aa3DBA10dE90",
"name": "eu proident",
"description": "nostrud adipisicing nisi minim"
},
{
"_id": "d2A5BdAd89E77A2FD1373b9F",
"name": "labore sit",
"description": "veniam dolor"
},
{
"_id": "7eEDD7b9aCE933A1ed7E1563",
"name": "dolore minim irure Ut laboris",
"description": "nulla in magna eu irure"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~1/IUT+B"
},
{
"type": "encryption",
"pointer": "/Y/gh/hi-di/~0/eh2s+CYB/Sut/~0/uF,3m7JH2+g"
},
{
"type": "encryption",
"pointer": "/~1/o/tg9v+S+-/~1/smxN/~1/~0/~0/hxCL6d"
},
{
"type": "encryption",
"pointer": "/~1/aMo+/BAz3U"
}
],
"migrationVersion": 99186727
}