iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

Query Parameters

There are various query parameters available that can be used to request information from a service. Features like filtering, selecting, and expansion add support for query parameters on GET request to receive additional information. These features are explained below:

• Select— The $select parameter indicates to the implementation that it should return a subset of the properties of the resource based on the value of the select clause.
• Filter— The $filter parameter indicates to the implementation that it should include a subset of the members of a collection based on the expression specified as the value of the filter clause. The $query parameter is a set of properties and literal values with an operator.
  NOTE While performing GET method using $filter with unsupported parameters, you may receive 400 status code response instead of 501.
• Expand— The $expand parameter indicates to the implementation that it should include a hyperlink as well as the contents of that hyperlink in the current response as if a GET had been performed and included in line with that hyperlink.
  NOTE

  • The $expand parameter is not supported for the URI

    /redfish/v1/Systems/<System-Id>

    .
  • While applying expand parameter on a resource, if the required license or privilege criteria for the resource are not met then a failure in sub resource may cause a failure in the entire output.
  • While performing GET method with $expand on unsupported URI, you may receive 400/404/405 status code instead of 501.
  • For PCIe slots and sensors schema, the Expand query parameter may not expand the resource.
• Only— The ?only parameter applies to resource collections. If the target Resource Collection contains exactly just one member, then use the only query parameter to get that member's resource.
  NOTE The ?only parameter is not supported on OEM resources.

See the section Examples for the examples of the above parameters.