search #

Searches for devices.

Query Syntax #

HTTP #

Copied to clipboard!

URL: http://kuzzle:7512/_/device-manager/:index/devices/_search[?from=<int>][&size=<int>][&scroll=<time to live>][&lang=<query language>]
Method: POST or GET
Body:

 Copied to clipboard!
{
  "query": {
    // ...
  },
  "aggregations": {
    // ...
  },
  "sort": [
    // ...
  ]
}

Other protocols #

 Copied to clipboard!
{
  "index": "<index>",
  "controller": "device-manager/device",
  "action": "search",
  "body": {
    "query": {
      // ...
    },
    "aggregations": {
      // ...
    },
    "sort": [
      // ...
    ]
  },

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

Kourou #

 Copied to clipboard!
kourou device-manager/device:search <index> --body '{
  query: {
    // search query
  }
}'

Arguments #

index: Tenant index name

Optional: #

from: paginates search results by defining the offset from the first result you want to fetch. Usually used with the size argument
scroll: creates a forward-only result cursor. This option must be set with a time duration, at the end of which the cursor is destroyed. If set, a cursor identifier named scrollId is returned in the results. This cursor can then be moved forward using the scroll API action
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 #

Optional: #

query: the search query itself, using the ElasticSearch Query DSL or the Koncorde Filters DSL syntax.
aggregations: control how the search result should be aggregated
sort: contains a list of fields, used to sort search results, in order of importance

An empty body matches all documents in the queried collection.

Only the following fields are available in the top level of the search body: aggregations, aggs, collapse, explain, from, highlight, query, search_timeout, size, sort, _name, _source, _source_excludes, _source_includes

Response #

Returns a paginated search result set, with the following properties:

aggregations: provides aggregation information. Present only if an aggregations object has been provided in the search body
hits: array of found documents. Each document has the following properties:
- _id: document unique identifier
- _score: relevance score
- _source: new document content
- highlight: optional result from highlight API
remaining: remaining documents that can be fetched. Present only if the scroll argument has been supplied - scrollId: identifier to the next page of result. Present only if the scroll argument has been supplied
total: total number of found documents. Can be greater than the number of documents in a result page, meaning that other matches than the one retrieved are available

 Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "action": "search",
  "controller": "device-manager/device",
  "requestId": "<unique request identifier>",
  "result": {
    "scrollId": "<scroll id>",
    "hits": [
      {
        "_id": "<device unique identifier>",
        "_score": 1,
        "_source": {
          // device content
        }
      },
      {
        "_id": "<another device unique identifier>",
        "_score": 1,
        "_source": {
          // device content
        }
      }
    ],
    // Present only if aggregation parameters have been set
    "aggregations": {
      "aggs_name": {}
    },
    "total": 42
  }
}