Query string

The base path for the URL reference can be followed by a query string containing parameters that provide additional processing information. The query string begins with a question mark and contains parameter/value pairs separated by ampersands (&).

Note that if a repository item is referenced by its resource identifier, the question mark initiating the query string is already present for the id parameter and should not be repeated for any other parameters.

At a minimum, a URL must contain the content repository path in the base path or the id parameter. Other parameters are optional. Unless otherwise stated, parameters and their values are case sensitive. Some parameters, such as username and password, are used in virtually all URL queries, while the use of other parameters may depend on the type of item being referenced in the query. Note that the system can be configured to use a custom authentication mechanism to eliminate the need to supply security credential parameters in the query string.

Reserved characters like & and excluded US-ASCII characters like # should be URL encoded before being specifying as a parameter value in the query string. However, characters in the reserved set are not reserved in all contexts. In general, a character is reserved if the semantics of the URI changes if the character is replaced with its escaped US-ASCII encoding. Hence some characters (like ?, =, and :) are not reserved in the parameter values, but characters like & and # are, and hence need to be URL encoded.

For example, the & character should be URL encoded as %26. Thus, the following URL:
http://yourserver:8080/peb/view/sample/employee.str?username=testuser&admin
should be specified as
http://yourserver:8080/peb/view/sample/employee.str?username=testuser%26admin