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": 95651536.48779362,
"y": 51626173.57211685
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 53288045.40171811,
"y": -10610023.73510483
},
"error_handler": {
"type": "operation",
"name": "childJob"
}
},
"transitions": {},
"groups": [
{
"name": "dolore culpa",
"provenance": "et"
},
{
"name": "in nulla",
"provenance": "Duis laboris occaecat magna exercitation"
},
{
"name": "sunt",
"provenance": "sed incididunt proident do"
},
{
"name": "anim consectetur laboris laborum",
"provenance": "dolor anim mollit amet"
},
{
"name": "in laborum mollit sed ad",
"provenance": "esse Lorem adipisicing exercitation magna"
}
],
"_id": "08618aea-7899-3070-64f9-f184a055293f",
"description": "ut quis Ut sed",
"errorHandler": {
"type": "in",
"name": "do ea ad cillum"
},
"font_size": 12,
"created": "1999-08-22T22:38:58.325Z",
"created_by": null,
"createdVersion": "laboris incididunt",
"last_updated": "2019-02-07T20:10:53.588Z",
"last_updated_by": {
"username": "do qui irure cillum officia",
"provenance": "in ipsum velit veniam dolore"
},
"lastUpdatedVersion": "Duis laboris",
"tags": [
{
"_id": "4CA1E4F6a0ca2d9fFed0f24d",
"name": "ea aliqua dolore",
"description": "sint magna"
},
{
"_id": "d8AcdCa27AcFABBDeD7C18dc",
"name": "nisi reprehenderit adipisicing ut voluptate",
"description": "in dolore Excepteur"
},
{
"_id": "c4Dc47e30DAB9De357C1B146",
"name": "ut dolore consequat consectetur",
"description": "ad occaecat"
}
],
"canvasVersion": 2
}