Query
To query a resource collection, which you can think of as a resource container,
perform an HTTP GET and accept a JSON response including at least a _queryFilter
or _queryId
parameter.
These parameters cannot be used together.
GET /users?_queryFilter=true HTTP/1.1
Host: example.com
Accept: application/json
The endpoint returns the result as a JSON object including a results
array
and other fields related to the query string parameters.
Parameters
You can use the following query string parameters:
Parameter | Description |
---|---|
|
Return only the specified fields in each element of the The If the |
|
The string is an opaque cookie to keep track of the position in the search results.
The service returns the cookie in the JSON response as the value of In the request Use this parameter with the The |
|
When The |
|
Return query results in pages of this size. After the initial request, use |
|
Format the body of the response. |
|
Query filters request entries matching the filter expression. You must URL-escape the filter expression. The string representation is summarized as follows:
JsonValue components of filter expressions follow
RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format.
In particular, as described in section 7 of the RFC, the escape character in strings is the backslash character.
For example, to match the identifier When using a query filter in a URL, notice the filter expression is part of a query string parameter.
URL-encoded the filter expression.
For details, refer to
RFC 3986: Uniform Resource Identifier (URI): Generic Syntax.
For example, whitespace, double quotes (
As a result, a backslash escape character in a JsonValue component
is percent-encoded in the URL query string parameter as A simple filter expression can represent a comparison, presence, or a literal value. For comparison expressions use json-pointer comparator json-value, where the comparator is one of the following:
For presence, use json-pointer pr to match resources where:
Literal values include true (match anything) and false (match nothing). Complex expressions employ |
|
Specify a query by its identifier. Specific queries can take their own query string parameter arguments depending on the implementation. |
|
Sort the resources returned based on the specified field(s) in As ascending order is the default, including the
The |
|
When a non-zero The
If no count policy is specified in the query, or if |