Query Parameters
Query parameters can be added to the end of the URI, following a '?' character. Multiple parameters can be specified by separating each parameter with an '&' character.
Each query parameter has the form <name>=<value>, where each value can be specified as a single string value, a simple wildcard by specifying a single asterisk (“*”) as the value, or a Perl regular expression, terminated with a semicolon and enclosed in quotes (”|<Perl regular expression>|;”).
The following list describes the optional query parameters:
Query Parameter | Description |
---|---|
max_age={max_seconds} | For queries that return a datapoint value, max_age specifies the maximum datapoint age for any returned datapoint values. max_age forces a poll request for the datapoint, if the last datapoint value is older than the time specified by max_seconds. The value cannot be specified as a regular expression. |
pg={page} | Specifies the collection of resources found on the page specified by page. Null means one (1).
|
sz={size} | Specifies the number of resources per page to be used for page requests. Must be an integer greater than zero. Null means no limit.
|
xs={snapshot_num} | Specifies the snapshot number to use when a page is requested using the pg parameter.
|