Core
API v2.x
2

# mCreateOrReplace

Creates or replaces multiple documents.

The number of documents that can be created or replaced by a single request is limited by the documentsWriteCount server configuration (see the Configuring Kuzzle guide).


# Query Syntax

# HTTP

Copied to clipboard!
URL: http://kuzzle:7512/<index>/<collection>/_mCreateOrReplace[?refresh=wait_for]
Method: PUT
Body:
Copied to clipboard!
{
  "documents": [
    {
      "_id": "<documentId>",
      "body": {
        // document content
      }
    },
    {
      "_id": "<anotherDocumentId>",
      "body": {
        // document content
      }
    }
  ]
}

# Other protocols

Copied to clipboard!
{
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "mCreateOrReplace",
  "body": {
    "documents": [
      {
        "_id": "<documentId>",
        "body": {
          // document content
        }
      },
      {
        "_id": "<anotherDocumentId>",
        "body": {
          // document content
        }
      }
    ]
  }
}

# Arguments

  • collection: collection name
  • index: index name

# Optional:

  • refresh: if set to wait_for, Kuzzle will not respond until the created/replaced documents are indexed

# Body properties

  • documents: an array of object. Each object describes a document to create or replace, by exposing the following properties:
    • _id: document unique identifier
    • body: document content

# Response

Returns an object containing 2 arrays: successes and errors

Each created or replaced document is an object of the successes array with the following properties:

  • _id: document unique identifier
  • _source: document content
  • _version: version of the document (should be 1)
  • created: a boolean telling whether a document is created (should be true)

Each errored document is an object of the errors array with the following properties:

  • document: original document that caused the error
  • status: HTTP error status code
  • reason: human readable reason

# Example

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "collection": "<collection>",
  "action": "mCreateOrReplace",
  "controller": "document",
  "requestId": "<unique request identifier>",
  "result": {
    "successes": [
      {
        "_id": "<documentId>",
        "_source": {
          // document content
        },
        "_version": 2,
        "created": true
      },
      {
        "_id": "<anotherDocumentId>",
        "_source": {
          // document content
        },
        "_version": 1,
        "created": false
      }
    ],
    "errors": [
      {
        "document": {
          // document content
        },
        "status": 400,
        "reason": "Missing document body"
      }
    ]

  }
}