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": "adipisicing",
"provenance": "aliqua fugiat minim id"
},
{
"name": "pariatur culpa nostrud",
"provenance": "deserunt officia"
},
{
"name": "cupidatat officia Lorem",
"provenance": "nulla"
},
{
"name": "sed amet",
"provenance": "proident aliqua sint"
}
],
"_id": "fd12e6bc-b67c-2a57-b539-c7df109c96cd",
"description": "fugiat",
"font_size": 12,
"created": "1996-01-11T13:37:15.292Z",
"created_by": {
"username": "dolor proident consequat tempor anim",
"provenance": "amet irure"
},
"last_updated": "1957-02-09T02:40:46.195Z",
"last_updated_by": {
"username": "exercitation sit",
"provenance": "dolore dolore nulla"
}
},
"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": 1192589,
"ok": 65238824,
"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"
]
}
}
}