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 dolore",
"provenance": "eu ipsum"
},
{
"name": "Excepteur consequat voluptate dolore",
"provenance": "mollit commodo nisi laboris"
}
],
"_id": "2c12d2fc-0d9f-52fb-1fdb-3a59164106d6",
"description": null,
"font_size": 12,
"created": "2008-02-02T19:05:24.672Z",
"created_by": {
"username": "eu officia culpa aliqua",
"provenance": "veniam sed consectetur anim Ut"
},
"last_updated": "2016-07-28T19:33:42.612Z",
"last_updated_by": {
"username": "Excepteur nisi dolor aute",
"provenance": "velit esse cupidatat cillum ut"
}
},
"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": 37188336,
"ok": 56597507,
"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"
]
}
}
}