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": "esse laborum sint deserunt"
}
}
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": "incididunt",
"provenance": "veniam fugiat voluptate exercitation"
},
{
"name": "sed",
"provenance": "mollit ea"
},
{
"name": "proident cupidatat nulla",
"provenance": "sed Lorem deserunt incididunt"
},
{
"name": "in aute",
"provenance": "id nulla proident consectetur quis"
}
],
"x": 40879374.60730812,
"y": 82294987.66147047
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "ullamco velit Ut",
"provenance": "deserunt qui"
}
],
"x": 67944773.55693176,
"y": -73556689.40479076
},
"error_handler": {
"name": "childJob",
"summary": "ad Lorem officia cupidatat occaecat",
"description": "officia id laborum",
"app": "non labore in aute sint",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~0/Aunq5C/~0/~1/~1/~0/ZV/~1/~0"
}
]
},
"groups": [
{
"name": "nisi veniam consequat in",
"provenance": "ut id sint non tempor"
},
{
"name": "cillum adipisicing",
"provenance": "in dolore dolor"
},
{
"name": "officia sunt ipsum Lorem amet",
"provenance": "et ullamco"
}
],
"x": -33146509.373333365,
"y": 91336434.77926615,
"type": "operation",
"gridCoordinate": {
"x": -97098455.27468573,
"y": -59292196.61727143
},
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "velit",
"provenance": "consectetur exercitation ad"
}
],
"_id": "eb7d26ef-b6ba-b2ee-1344-f23332e046c5",
"description": "nostrud adipisicing tempor ipsum labore",
"errorHandler": null,
"font_size": 12,
"created": "1966-03-26T05:44:49.882Z",
"created_by": {
"username": "adipisicing laboris in reprehenderit",
"provenance": "non pariatur"
},
"createdVersion": "consequat do in",
"last_updated": "1976-06-11T12:40:53.322Z",
"last_updated_by": {
"username": "nulla amet occaecat nostrud reprehenderit",
"provenance": "pariatur"
},
"lastUpdatedVersion": "tempor magna ut consequat",
"tags": [
{
"_id": "29EEcfCBf5Df11Ff2e2970cB",
"name": "ullamco veniam ut",
"description": "cupidatat est"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/ri1n6zvTiTH/~1/~1/~1/~0/ZM4j7V/zuskF/Tn0zbvhY,/lF,3yY"
},
{
"type": "encryption",
"pointer": "/~0/~0/gCAqU9Gmo0k/S"
},
{
"type": "encryption",
"pointer": "/~1/ELHV/~0/d-DX/PZdC5zoD,N/hnN/~0/IYnvay/VlC/chhJs/y3mCV6GfRMB"
}
],
"migrationVersion": 93563439
}
