Summary
Import Workflow
Description
Import a single Workflow
Route
POST /workflow_engine/workflows/import
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| workflow |
object |
yes |
A workflow payload object |
| options |
object |
yes |
Import options: adapterMap (optional) |
Copied to Clipboard
{
"workflow": {
"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": [
"43ccbd8cd4f9a44e2b790fe5",
"b831daaf5f38511edae3ada2",
"94cb5bf3152a7fe3d0457d55",
"c47d90ac40de051a05b3d99b",
"a6b5191d3e796973e5bb56d0"
],
"_id": "212c5a51-645d-941b-a561-185f897e0c48",
"description": null,
"font_size": 12,
"created": "1986-07-26T09:03:03.939Z",
"created_by": "ebbe95e43731681bf92d4865",
"last_updated": "2018-02-17T07:40:57.331Z",
"last_updated_by": "bf66e2100ac109ebcb1606d3"
},
"options": {}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"$ref": "workflowDocument"
},
"options": {
"type": "object",
"properties": {
"adapterMap": {
"type": "object"
}
}
}
},
"required": [
"workflow",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Import status Object |
Copied to Clipboard
{
"n": 67696904,
"ok": 78121170,
"name": "workflowName"
}
Copied to Clipboard
{
"title": "result",
"properties": {
"n": {
"type": "integer",
"minimum": 0
},
"ok": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"examples": [
"workflowName"
]
}
}
}
