Official Plugins (Kuzzle v2.x)
Workflows v1.x
2

This plugin is part of the Kuzzle Enterprise Plan. If you are interested, please contact us.

create #

Creates a new workflow engine on an index


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/_/workflows/engine/:index
Method: POST

Other protocols #

Copied to clipboard!
{
  "controller": "workflows/engine",
  "action": "create",
  "index": "tenant-ayse",
}

Kourou #

Copied to clipboard!
kourou workflows/engine:create <index>

Response #

Returns an object containing the index name and the list of created collections with their mappings.

Copied to clipboard!
{
  "requestId": "d16d5e8c-464a-4589-938f-fd84f46080b9",
  "status": 200,
  "error": null,
  "controller": "workflows/engine",
  "action": "create",
  "collection": null,
  "index": null,
  "result": { 
    "index": "tenant-ayse",
    "collections": {
      "workflows": {
        "properties": {
          // Mappings properties
        }
      },
    }
  }
}