Query parameters
Syntax information about the OSLC query parameters that are supported by the HTTP interface.
| Query parameter | Description |
|---|---|
| filter | This query parameter defines which rows the request acts on, when the request is made to the ObjectServer. Use the same format for this parameter as for an SQL WHERE clause. You can use this parameter only with GET, PATCH, and DELETE requests to an ObjectServer table collection URI. The following example shows a sample filter parameter. The following example shows the same parameter after it is encoded for use in a URI. The following example shows a sample URI that contains this parameter. |
| collist | This query parameter is valid only on an HTTP
GET request. The parameter defines which columns of the table to return
in the JSON row set message. To define the value of the parameter,
use the same syntax as the column list component of a SQL SELECT statement. The following example shows a sample collist parameter. The following example shows the same parameter after it is encoded for use in a URI. The following example shows a sample URI that contains this parameter. |
| orderby | This query parameter is valid only on an HTTP
GET request to an ObjectServer table collection URI. The parameter
defines the order of rows in the JSON row set message that is returned.
To define the value of the parameter, use the same syntax as the ORDER
BY clause of a SQL SELECT statement. The following example shows a sample orderby parameter. The following example shows the same parameter after it is encoded for use in a URI. The following example shows a sample URI that contains this parameter. |
The following example shows a URI that uses all the query parameters in Table 1.
http://localhost/objectserver/restapi/alerts/status?filter=Node%3D%27hostname.domain%27&collist=Serial%2CNode%2CSummary&Serial%20ASC&orderby=Serial%20ASC