Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_builder/export
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
match a workflow using _id or name or type |
Copied to Clipboard
{
"options": {
"_id": "5cb7b531d06cceb89fd21b1c",
"name": "someWorkflowName",
"type": "automation"
}
}
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",
"examples": [
"someWorkflowName"
]
},
"type": {
"type": "string",
"description": "The type of the workflow",
"examples": [
"automation"
]
}
},
"additionalProperties": false
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| 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": -60911897.58831108,
"y": -59783781.258284606
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 94585164.48631048,
"y": -82585437.14475742
},
"error_handler": {
"name": "childJob",
"summary": "adipisicing dolor ut laborum",
"description": "anim nisi ea",
"app": "mollit nisi Excepteur sint",
"variables": {
"error": ""
},
"groups": [
{
"name": "exercitation ad est",
"provenance": "culpa ipsum dolore laboris id"
}
],
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "est laborum magna culpa eiusmod",
"provenance": "quis in eiusmod"
}
],
"_id": "fca3a419-edcc-3523-9919-65fdebef508e",
"description": "Ut sit cillum",
"errorHandler": null,
"font_size": 12,
"created": "1986-05-08T02:31:11.625Z",
"created_by": null,
"createdVersion": "in consectetur",
"last_updated": "1995-11-22T13:40:41.082Z",
"last_updated_by": {
"username": "Lorem",
"provenance": "ad velit nulla in"
},
"lastUpdatedVersion": "velit enim incididunt",
"tags": [
{
"_id": "cB8250b3aFd061fD7ACB729e",
"name": "irure amet eu aute",
"description": "ullamco mollit fugiat ut"
}
],
"canvasVersion": 2
}
