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": "cupidatat nostrud enim dolor"
}
}
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": 51512329.48775363,
"y": -47195749.44860794
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 56938358.51372734,
"y": -36288179.08832991
},
"error_handler": {
"name": "childJob",
"summary": "ad dolore aliquip in voluptate",
"description": "sed Ut",
"app": "voluptate sed",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~0/~0"
},
{
"type": "encryption",
"pointer": "/fhSQiany+/XsZ"
},
{
"type": "encryption",
"pointer": "/~1/wFfXiY/Ew/~1"
},
{
"type": "encryption",
"pointer": "/~1/~1/XhY/w/tYQDsj6AZn8/oLfko+Ahs7/~1/CzX7HVkWu/~1/~1"
}
]
},
"groups": [
{
"name": "id",
"provenance": "eu amet"
},
{
"name": "eiusmod minim reprehenderit et",
"provenance": "cupidatat do"
}
],
"type": "operation",
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "et cupidatat aliquip nulla",
"provenance": "Ut elit minim ipsum"
},
{
"name": "exercitation et sed sit",
"provenance": "quis ullamco"
},
{
"name": "voluptate eiusmod enim cillum",
"provenance": "irure elit"
},
{
"name": "esse sunt veniam ad enim",
"provenance": "veniam"
}
],
"_id": "2e407d86-a019-628f-2d79-a8271e2ebe58",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "2014-10-10T15:37:10.637Z",
"created_by": null,
"createdVersion": "Ut amet esse culpa",
"last_updated": "2019-03-18T15:52:36.384Z",
"last_updated_by": {
"username": "tempor sit elit laboris",
"provenance": "anim id dolor"
},
"lastUpdatedVersion": "laboris",
"tags": [
{
"_id": "dbf0E629Cd1b29df92a04c96",
"name": "Excepteur fugiat consequat ut",
"description": "id officia labore"
},
{
"_id": "eDF3cd2acEcAcb7bc4f909DB",
"name": "est",
"description": "officia commodo"
},
{
"_id": "a39e78F9F5F6A51BA148A7EC",
"name": "ullamco consectetur",
"description": "ullamco"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/gZX-hel/ZAw+fhbQ"
},
{
"type": "encryption",
"pointer": "/qhlTP1N//t6.jZ/~1/~1/nee5sH/~1/~1/H9iBu+-fpi/~1/~1"
}
],
"migrationVersion": 59463690
}