ApiSearchResult Data Type

A search result. Contains metadata about a search, such as result set size, and the actual search results.

Properties
name data type description
results array of map of object The search results as JSON objects.
facets map of object The facets that have been requested with an ApiSearchRequest.
_metadata ResponseMetadata Meta data about the search operation.

Example

{
  "results" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "facets" : {
    "property1" : { },
    "property2" : { }
  },
  "_metadata" : {
    "query" : {
      "property1" : { },
      "property2" : { }
    },
    "resultset" : {
      "count" : 10,
      "from" : 2,
      "size" : 8,
      "truncated" : true
    }
  }
}