REST Server Processes - eXist: A NoSQL Database and Application Development Platform - page 531

The boxes in the flowchart with dotted outlines (“Has cache Parameter?” and “Cache
Results”) indicate that these steps are only considered when an XQuery is POST ed to
the REST Server API, and not when a stored query is invoked using a POST request to
the REST Server API.
REST Server Parameters
Next we detail the parameters available for use when you are making requests to
eXist's REST Server.
Note that several of the parameters are similar for GET and POST requests. Parameters
are always written lowercase; however, when they are used in the query of a URL for
an HTTP GET request they are also prefixed with an _ (underscore) character.
HTTP GET Parameters
The parameters detailed here can be used in the query string of a URL when you are
performing an HTTP GET .
When placing values into query parameters you may need to URL-
encode them, depending on the HTTP client that you are using.
Many HTTP clients (such as web browsers) will auto-encode the
parameters. If you are using Java's java.net.URLConnection , how‐
ever, you should be aware that it does not auto-encode the parame‐
ters, and you will need to encode each value with
java.net.URLEncoder .
Many client and server applications have a limit on the amount of
data that can be placed into the URL query string, so if you are
making complex queries you should consider using POST instead of
GET . For more information, see “HTTP POST Parameters” on page
536 .
For clarity, the query parameter values in Table B-1 are shown before encoding.