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": "4321abcdef694aa79dae47ad",
"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": 52141594.08108553,
"y": 27665895.416391432
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 99070012.06858906,
"y": 37530744.94426653
}
},
"transitions": {},
"groups": [
{
"name": "exercitation ut adipisicing",
"provenance": "eiusmod ex amet magna"
},
{
"name": "eiusmod sit",
"provenance": "ex pariatur"
},
{
"name": "incididunt cillum sunt",
"provenance": "minim ullamco"
},
{
"name": "mollit aute ut sed adipisicing",
"provenance": "amet"
}
],
"_id": "6c8a7309-c581-359e-b262-04920428bedc",
"description": null,
"font_size": 12,
"created": "2009-05-18T17:18:13.753Z",
"created_by": null,
"createdVersion": "in occaecat commodo in cillum",
"last_updated": "1947-03-18T11:38:19.802Z",
"last_updated_by": null,
"lastUpdatedVersion": "sint eiusmod aute"
}