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": [
"0db6127e84bede2ed501a219",
"d2f52fa1ba9347822f6364ba"
],
"_id": "7f7f8324-b75c-1ddd-171e-9db7516d1ac5",
"description": "esse consectetur",
"font_size": 12,
"created": "1967-02-22T17:21:57.374Z",
"created_by": "76ad91d544906af7fc5a5fcf",
"last_updated": "1962-01-28T13:05:23.052Z",
"last_updated_by": "a34df2046d7fa34a21d0a598"
},
"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": 29186726,
"ok": 52735506,
"name": "workflowName"
}
Copied to Clipboard
{
"title": "result",
"properties": {
"n": {
"type": "integer",
"minimum": 0
},
"ok": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"examples": [
"workflowName"
]
}
}
}