URI Query Rule
URIs, as described in RFC3986, may also contain a query (?query) and a frag (#frag) component. Queries are addressed in the clause Query Parameters as Redfish Scalable Platforms Management API Specification DSP0266 described. Fragments (frag) should be ignored by the server when used as the URI for submitting an operation.
Resource URI | Description |
|---|---|
/redfish/v1/Systems?$skip=1 | Services support the odata query parameters. $skip, $top, $expand, $select, $filter, excerpt, only |
/redfish/v1/Systems?$expand=* /redfish/v1/Systems?$expand=. /redfish/v1/Systems?$expand=~ /redfish/v1/Systems?$expand=.($levels=2) | The $expand query supports asterisk (*), period (.) and tilde (~) to determine which hyperlinks should be expanded. The $levels indicates how many levels the service should cascade the expand operation. |
/redfish/v1/Systems?$except=1 | Implementation shall return the 501, Not Implemented, status code for any query parameters starting with "$" that are not supported and should return an extended error indicating the requested query parameter(s) not supported for this resource. |
/redfish/v1/Systems?only&$expand=* | Implementations shall return the 400, Bad Request, status code if only is being combined with other query parameters. |
/redfish/v1/?1 | Implementations shall ignore unknown or unsupported query parameters that do not begin with "$". |
/redfish/v1/# /redfish/v1/#5555 /redfish/v1/##?$top=1 | Fragments (#frag) shall be ignored by the server when used as the URI for submitting an operation. |