Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_engine/workflows/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": {
"allOf": [
{
"$ref": "wfEngineCommon#/definitions/mongoObjectId"
},
{
"description": "The Id of the workflow to export"
}
]
},
"name": {
"type": "string",
"description": "The name of the workflow to export",
"examples": [
"someWorkflowName"
]
},
"type": {
"type": "string",
"description": "The type of the workflow to export",
"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": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
}
},
"transitions": {},
"groups": [
{
"name": "Lorem Excepteur eiusmod qui aliqua",
"provenance": "anim amet nisi"
},
{
"name": "culpa ut voluptate",
"provenance": "aliqua"
},
{
"name": "id in",
"provenance": "id nostrud ullamco est"
},
{
"name": "adipisicing ex Duis nostrud Lorem",
"provenance": "aute incididunt voluptate amet ea"
}
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"font_size": 12,
"created": "1988-11-19T15:45:50.956Z",
"created_by": {
"username": "tempor laboris deserunt incididunt reprehenderit",
"provenance": "in deserunt enim adipisicing"
},
"last_updated": "1959-09-30T05:33:18.484Z",
"last_updated_by": {
"username": "id in irure sint et",
"provenance": "magna"
}
}