replace

Replaces the content of an existing document.


Query Syntax

HTTP

Copied to clipboard!
URL: http://kuzzle:7512/<index>/<collection>/<documentId>/_replace[?refresh=wait_for]
Method: PUT
Body:
Copied to clipboard!
{
  // new document content
}

Other protocols

Copied to clipboard!
{
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "replace",
  "_id": "<documentId>",
  "refresh": "wait_for",
  "body": {
    // new document content
  }
}

Arguments

  • collection: collection name
  • documentId: unique ID of the document to replace
  • index: index name

Optional:

  • refresh: if set to wait_for, Kuzzle will not respond until the new document content is indexed

Body properties

New document content.


Response

Returns an object containing updated document information, with the following properties:

  • _id: document unique identifier
  • _source: new document content
  • _version: updated document version number
Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "replace",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<documentId>",
    "_source": {
      // new document content
    },
    "_version": 13
  }
}