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": "minim fugiat",
"provenance": "id consectetur ad nisi"
},
{
"name": "commodo dolore ipsum qui incididunt",
"provenance": "reprehenderit"
},
{
"name": "adipisicing fugiat ea aliquip in",
"provenance": "quis aute dolore in reprehenderit"
}
],
"_id": "e906d530-a8ed-7ba3-fa6c-9ea901646d60",
"description": "deserunt in",
"font_size": 12,
"created": "1959-01-14T10:35:49.933Z",
"created_by": {
"username": "dolor id Lorem",
"provenance": "sed enim voluptate reprehenderit"
},
"last_updated": "1978-08-18T18:35:17.838Z",
"last_updated_by": {
"username": "elit nulla",
"provenance": "Excepteur"
}
},
"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": 3241614,
"ok": 77909856,
"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"
]
}
}
}