search #

Searches for devices.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/device-manager/:engineId/devices/_search
Method: POST

Other protocols #

{
  "controller": "device-manager/devices",
  "action": "search",
  "engineId": "<engineId>",
  "body": {
    "query": {
      // ...
    },
    "sort": [
      // ...
    ]
  },

  // optional:
  "from": "<starting offset>",
  "size": "<page size>",
  "lang": "<query language>"
}

Arguments #

engineId: engine id
from: paginates search results by defining the offset from the first result you want to fetch. Usually used with the size argument
size: set the maximum number of documents returned per result page
lang: specify the query language to use. By default, it's elasticsearch but koncorde can also be used.

Body properties #

query: the search query itself, using the ElasticSearch Query DSL or the Koncorde Filters DSL syntax.
sort: contains a list of fields, used to sort search results, in order of importance

Response #

{
  "status": 200,
  "error": null,
  "controller": "device-manager/devices",
  "action": "search",
  "requestId": "<unique request identifier>",
  "result": {
    "hits": [
      {
        "_id": "<deviceId>",
        "_source": {
          // Device content
        },
      },
    ],
    "total": 42
  }
}

Edit this page on Github