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": "incididunt commodo"
}
}
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": -16711117.5757972,
"y": 24735486.00562583
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -43699026.70049988,
"y": 87129250.3591024
},
"error_handler": {
"name": "childJob",
"summary": "dolore officia dolore nulla",
"description": "dolore dolore Excepteur",
"app": "irure quis",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~1/~0"
},
{
"type": "encryption",
"pointer": "/o/~1/Y+RBAjR/Vb/M/~1/~1/r0MJPU/F/~0"
}
]
},
"groups": [
{
"name": "quis",
"provenance": "sint nisi tempor Duis"
},
{
"name": "laboris amet et exercitation cillum",
"provenance": "dolore non"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "aute voluptate consectetur dolor officia",
"provenance": "occaecat magna amet Excepteur"
},
{
"name": "Lorem cillum",
"provenance": "velit sit aliqua dolore"
}
],
"_id": "0f8df571-c3c8-8b8e-99ed-20729d1780fd",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "1953-05-02T14:06:14.011Z",
"created_by": {
"username": "exercitation consectetur",
"provenance": "dolore cillum qui deserunt non"
},
"createdVersion": "ut quis anim consequat",
"last_updated": "1945-03-04T06:14:56.703Z",
"last_updated_by": null,
"lastUpdatedVersion": "Lorem culpa",
"tags": [
{
"_id": "3ad2cE5AB7bB996bc58eeFE2",
"name": "dolore in elit",
"description": "id fugiat labore"
},
{
"_id": "8eea89aF7F79cb3b5eCeb59d",
"name": "in",
"description": "qui ea voluptate"
},
{
"_id": "6AcBFEA372D4e5DfCD55cAee",
"name": "consequat",
"description": "sunt ad nulla fugiat"
},
{
"_id": "f40B0eCB6Fdb54Ca4264eFD9",
"name": "ut",
"description": "et exercitation"
}
],
"canvasVersion": 2,
"decorators": [
{
"type": "encryption",
"pointer": "/pt,tim0fQ/Y0AwDednM/Akh04t/~0/F/~1/Joxt7+i/~1"
},
{
"type": "encryption",
"pointer": "/st3qhQ72pe/A0/Yij-P.Tk/o.ff,v9iE/S-I/cPgw"
},
{
"type": "encryption",
"pointer": "/~1/s/PQ,.zdjfjD/~0/~1/~1/Q6uKeU.v.5/YDMOJtoEg"
}
],
"migrationVersion": 12369817
}