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": -8511970.309215754,
"y": -57253944.450024985
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 47637678.22522104,
"y": -4614134.257973969
}
},
"transitions": {},
"groups": [
{
"name": "officia sit amet do in",
"provenance": "ut et sunt aute"
},
{
"name": "incididunt",
"provenance": "reprehenderit fugiat culpa"
}
],
"_id": "a7792ae2-d571-51f7-b136-722e78457511",
"description": "sint aliquip",
"font_size": 12,
"created": "1945-01-30T13:29:34.263Z",
"created_by": {
"username": "cupidatat mollit eu consectetur",
"provenance": "enim id"
},
"createdVersion": "est esse incididunt",
"last_updated": "2020-04-08T10:51:07.189Z",
"last_updated_by": null,
"lastUpdatedVersion": "esse labore"
}
