Object Query via Entity

An object query can be performed by passing all parameters in an input entity. Because some clients do not support HTTP GET-with-entity, the PUT method can be used instead, even though no modifications are made. Both these examples are equivalent:

GET /{application}/{table}/_query

PUT /{application}/{table}/_query

The entity passed in the command must be a JSON or XML document whose root element is search. The query parameters are given as child elements. URI query parameters map to the following element names:

URI Parameter	Element name
e	continue-at
f	fields
g	continue-after
k	skip
o	order
m	metric
q	query
s	size
shards	shards
range	shards-range
uncommitted	uncommitted

 

Here is an example search document in XML:

<search>

<query>LastName=Powell</query>

<fields>Name,Manager(Name),DirectReports(Name)</fields>

<shards>2014-01-01</shards>

</search>

The same example in JSON:

{"search": {

"query": "LastName=Powell",

"fields": "Name,Manager(Name),DirectReports(Name)",

"shards": "2014-01-01"

}}