Built-in Parameters

The following URL parameters have special meaning and can be passed in through the URL of the request:

GET Parameter	Description
&plainText=true	Response will always be Content-Type: text/plain and the returned text will be human-readable (WriterSerializer.Builder.useWhitespace() enabled). Useful for debugging.
&method=X	Overload the HTTP method as a GET parameter (e.g. OPTIONS or HEAD). The name is matched case-insensitively and read from the query string only. On a safe request (GET, HEAD, OPTIONS, TRACE) the override is honored only for another safe method or an operation declared @RestOp(read=true); anything else is refused with 405. On a POST any admitted method is honored. Must be enabled via @Rest(allowedMethodParams) setting.
&Header-Name=headerValue	Specify a header value as a GET parameter (e.g. &Accept=text/json). Must be enabled via @Rest(allowedHeaderParams) setting.
&content=X	Pass in the HTTP body content on PUT and POST methods as a UON-encoded GET parameter (e.g. ?content=(name='John%20Smith',age=45)). Honored on PUT/POST only. Can be disabled via @Rest(disableContentParam) setting.
&x-response-headers=X	Pass-through headers to the response. Must be a UON-encoded map of key-value pairs.
&juneauSerializerOptions=X	Override serializer session options for this request. Must be a UON-encoded map; keys must be in the @Rest(allowedSerializerOptions) allowlist or the request fails with 400 Bad Request.
&juneauParserOptions=X	Override parser session options for this request. Must be a UON-encoded map; keys must be in the @Rest(allowedParserOptions) allowlist or the request fails with 400 Bad Request.

note

Earlier releases documented &debug=true and &noTrace=true URL parameters. These no longer exist. Request debugging is now driven by the JUL logger level (see Logging / Debugging), and the /echo endpoint must be enabled explicitly via EchoMixin.