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": 92969141.57653156,
"y": -6217929.1253118515
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 44201156.19260475,
"y": 19078873.95836374
},
"error_handler": {
"name": "childJob",
"summary": "mollit in aliqua elit incididunt",
"description": "Ut deserunt",
"app": "nisi nostrud aute",
"variables": {
"error": ""
},
"groups": [
{
"name": "Ut",
"provenance": "minim proident"
}
],
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "magna Duis cupidatat incididunt nostrud",
"provenance": "ullamco esse"
}
],
"_id": "07a72628-276d-4ccf-cd35-74d04bc9fd61",
"description": null,
"errorHandler": {
"type": "exercitation minim enim in Duis",
"name": "magna cupidatat"
},
"font_size": 12,
"created": "1996-09-08T21:25:09.629Z",
"created_by": {
"username": "quis est ea dolor velit",
"provenance": "non eiusmod"
},
"createdVersion": "quis eiusmod",
"last_updated": "2011-07-30T06:13:03.224Z",
"last_updated_by": {
"username": "dolor Ut amet non ipsum",
"provenance": "nisi"
},
"lastUpdatedVersion": "incididunt",
"tags": [
{
"_id": "6f8fD5Ec06d89B6bE0AEDB3c",
"name": "in pariatur",
"description": "dolor quis"
},
{
"_id": "B9CFf302B6CbC197f4Bf7d07",
"name": "Excepteur",
"description": "in nulla ea fugiat Duis"
},
{
"_id": "C68CB7b62d79EE8EF3FAA75d",
"name": "est",
"description": "deserunt sint reprehenderit est"
},
{
"_id": "Abd03e3b6491F9e3D02fCA31",
"name": "ad",
"description": "eiusmod tempor sit laboris pariatur"
},
{
"_id": "B5F68d59E9518fc4cBddEf16",
"name": "velit",
"description": "exercitation"
}
],
"canvasVersion": 2
}