Aggregate Query via Entity

Aggregate query parameters can be provided in an input entity instead of URI parameters. The same REST command is used except that no URI parameters are provided. Because some browsers/HTTP frameworks do not support HTTP GET-with-entity, this command also supports the PUT method even though no modifications are made. Both of the following are equivalent:

GET /{application}/{table}/_aggregate

PUT /{application}/{table}/_aggregate

where {application} is the application name and {table} is the perspective table. The input entity must be a JSON or XML document whose root element is aggregate-search. Aggregate query parameters are given as child elements. URI query parameters map to the following element names:

URI Parameter	Element name
q	query
m	metric
f	grouping-fields
pair	pair
shards	shards
range	shards-range
xshards	x-shards
xrange	x-shards-range

 

Below is an example aggregate query request entity in XML:

<aggregate-search>

<query>Size&gt;10000</query>

<metric>COUNT(*)</metric>

<grouping-fields>TOP(3,Sender.Person.Department)</grouping-fields>

<shards-range>2014</shards-range>

</aggregate-search>

In JSON:

{"aggregate-search": {

"query": "Size>10000",

"metric": "COUNT(*)",

"grouping-fields": "TOP(3,Sender.Person.Department)",

"shards-range": "2014"

}}