mCreateOrReplace
Creates or replaces multiple documents.
Query Syntax
HTTP
URL: http://kuzzle:7512/<index>/<collection>/_mCreateOrReplace[?refresh=wait_for]
Method: PUT
Body:
{
"documents": [
{
"_id": "<documentId>",
"body": {
// document content
}
},
{
"_id": "<anotherDocumentId>",
"body": {
// document content
}
}
]
}
Other protocols
{
"index": "<index>",
"collection": "<collection>",
"controller": "document",
"action": "mCreateOrReplace",
"body": {
"documents": [
{
"_id": "<documentId>",
"body": {
// document content
}
},
{
"_id": "<anotherDocumentId>",
"body": {
// document content
}
}
]
}
}
Arguments
collection
: collection nameindex
: index name
Optional:
refresh
: if set towait_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 identifierbody
: 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 be1
)created
: a boolean telling whether a document is created (should betrue
)
Each errored document is an object of the errors
array with the following properties:
document
: original document that caused the errorstatus
: HTTP error status codereason
: human readable reason
Example
{
"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"
}
]
}
}