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": [
{
"name": "in",
"provenance": "culpa velit"
},
{
"name": "ex consectetur labore irure",
"provenance": "reprehenderit aliquip consectetur cupidatat laborum"
},
{
"name": "nulla elit occaecat",
"provenance": "eiusmod veniam voluptate esse exercitation"
},
{
"name": "deserunt",
"provenance": "quis do"
},
{
"name": "elit nostrud exercitation",
"provenance": "non Ut dolor et anim"
}
],
"_id": "1ff04ccc-67b1-0db9-4c27-1f2e28454dea",
"description": "fugiat",
"font_size": 12,
"created": "1950-06-15T16:17:47.199Z",
"created_by": {
"username": "dolore adipisicing officia",
"provenance": "amet non deserunt"
},
"last_updated": "1965-11-14T04:26:13.96Z",
"last_updated_by": {
"username": "pariatur ex ad eu",
"provenance": "qui in"
}
},
"options": {}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"$ref": "workflowPayload"
},
"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": 52058321,
"ok": 54014727,
"name": "workflowName"
}
Copied to Clipboard
{
"type": "object",
"title": "result",
"properties": {
"n": {
"type": "integer",
"minimum": 0
},
"ok": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"examples": [
"workflowName"
]
}
}
}