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": "irure fugiat aliqua"
}
}
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": [
{
"name": "est in reprehenderit Duis sit",
"provenance": "non ad sunt reprehenderit laborum"
},
{
"name": "aliqua Duis irure est",
"provenance": "ea ut nulla ullamco"
},
{
"name": "esse id Lorem",
"provenance": "Duis nisi"
},
{
"name": "ipsum laboris officia commodo consequat",
"provenance": "ipsum ut"
},
{
"name": "Excepteur ut voluptate esse elit",
"provenance": "commodo dolor non sit"
}
],
"x": -50447139.65146599,
"y": 66166929.35753989
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "sit non",
"provenance": "labore ea dolore in"
},
{
"name": "Lorem",
"provenance": "nisi dolor deserunt culpa"
},
{
"name": "aliquip magna enim exercitation occaecat",
"provenance": "officia eu velit qui"
},
{
"name": "velit adipisicing",
"provenance": "nulla enim ea"
}
],
"x": -21606894.633785695,
"y": 51772464.06440821
},
"error_handler": {
"name": "childJob",
"summary": "commodo veniam dolore id",
"description": "in enim proident laboris est",
"app": "voluptate aliquip",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/D04/~1/~1/W-/tWDOd/pSP"
},
{
"type": "encryption",
"pointer": "/~0/~1/~0/~0/DHaTP"
}
]
},
"groups": [
{
"name": "ex sunt est in tempor",
"provenance": "esse"
}
],
"x": 48296390.50886628,
"y": 31171857.345632374,
"type": "operation",
"gridCoordinate": {
"x": -28530392.75775124,
"y": -86680385.97610831
},
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "consectetur reprehenderit esse incididunt consequat",
"provenance": "laboris eiusmod"
},
{
"name": "sint cillum",
"provenance": "consectetur ullamco occaecat"
},
{
"name": "culpa tempor nulla",
"provenance": "nulla adipisicing sint"
}
],
"_id": "76a9c71b-7db4-a70d-2071-812e83961e2e",
"description": null,
"namespace": null,
"errorHandler": null,
"font_size": 12,
"created": "1951-09-07T01:20:26.979Z",
"created_by": null,
"createdVersion": "velit",
"last_updated": "1958-09-13T06:40:45.377Z",
"last_updated_by": null,
"lastUpdatedVersion": "proident nostrud",
"tags": [
{
"_id": "30CaFfd6fAB0E887ce4D91E0",
"name": "mollit non",
"description": "quis adipisicing in"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/HI2Zy8H/~0/~0/~0/~1/A/CY/~1/~1/~1"
},
{
"type": "encryption",
"pointer": "/~0/~0/NGgVZf/RY7uu5M7XP"
},
{
"type": "encryption",
"pointer": "/~0"
},
{
"type": "encryption",
"pointer": "/jPGXQ/~0/qlc9/~0/z5e7YUQV/~0"
},
{
"type": "encryption",
"pointer": "/~1/cwrK/Of/d6hB/~0/~1/~0"
}
],
"migrationVersion": 76752609
}