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": "magna deserunt 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": -41227498.01426111,
"y": 42019934.5177995
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 66758092.533380836,
"y": -7813860.466997415
},
"error_handler": {
"name": "childJob",
"summary": "Lorem magna aliquip dolore",
"description": "proident sint Ut mollit",
"app": "ea",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~0/~0/ZQMHX+/t.S5b1T0/~0/rX7pw8l/tqWeZjDJT/u4tYP/"
}
]
},
"groups": [
{
"name": "elit anim tempor",
"provenance": "laborum non ipsum"
}
],
"type": "operation",
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "aliqua ad",
"provenance": "est"
},
{
"name": "dolor nulla cillum",
"provenance": "aliquip elit pariatur quis"
},
{
"name": "consectetur sed aliqua elit",
"provenance": "ullamco esse commodo ea"
},
{
"name": "dolor tempor",
"provenance": "dolore sed dolor"
}
],
"_id": "3a31d19d-a351-c427-502b-7496bb655b68",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1971-04-02T03:38:56.185Z",
"created_by": null,
"createdVersion": "dolor quis reprehenderit in",
"last_updated": "1974-11-30T08:02:09.996Z",
"last_updated_by": {
"username": "culpa tempor",
"provenance": "irure voluptate qui aliquip dolor"
},
"lastUpdatedVersion": "quis cupidatat enim ea elit",
"tags": [
{
"_id": "28c644c33662fafb337506C7",
"name": "Excepteur commodo dolore",
"description": "adipisicing consectetur et"
},
{
"_id": "D98Fff5be398c63F170AD1Ea",
"name": "aute in fugiat deserunt eu",
"description": "ut reprehenderit"
},
{
"_id": "48Ca99DCA3E6dd6A9a77b4Fe",
"name": "laborum",
"description": "Lorem veniam amet minim Excepteur"
},
{
"_id": "25CB9D7faEd5C7a056Ee23cc",
"name": "exercitation occaecat labore",
"description": "qui mollit proident"
},
{
"_id": "cCd4385bE4d7aA409e67f6e5",
"name": "elit officia eiusmod sed",
"description": "minim incididunt velit aliquip est"
}
],
"canvasVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~1/tB.kY"
}
],
"migrationVersion": 15904670
}