Kuzzle
Documentation
2

update #

Applies partial changes to a device.

See also the document:update API action.

Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/_/device-manager/:index/devices/:_id[?refresh=wait_for][&retryOnConflict=<int>][&source]
Method: PUT
Body:
Copied to clipboard!
{
  // device changes
}

Other protocols #

Copied to clipboard!
{
  "index": "<index>",
  "controller": "device-manager/device",
  "action": "update",
  "_id": "<deviceId>",
  "body": {
    // device changes
  }
}

Kourou #

Copied to clipboard!
kourou device-manager/device:update <index> --id <deviceId> --body '{
  // device changes
}'

Arguments #

  • index: Tenant index name

Optional: #

  • refresh: if set to wait_for, Kuzzle will not respond until the update is indexed
  • retryOnConflict: conflicts may occur if the same document gets updated multiple times within a short timespan, in a database cluster. You can set the retryOnConflict optional argument (with a retry count), to tell Kuzzle to retry the failing updates the specified amount of times before rejecting the request with an error.
  • source: if set to true Kuzzle will return the entire updated document body in the response.

Body properties #

Partial changes to apply to the device.

Response #

Returns information about the updated device:

  • _id: device unique identifier
  • _version: updated device version
  • _source: contains only changes or the full device if source is set to true
Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "controller": "device-manager/device",
  "action": "update",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<deviceId>",
    "_version": 2,
    "_source": "<partial or entire document>"
  }
}