HP OneView REST API Reference
Common REST API Parameters
stdparams.html[10/17/2013 10:36:08 AM]
Not expected to work: expressions that reference nested fields
Notes
NOT is used to negate the condition.
The operands [ GT, GE, LT, LE ] only apply to numeric attributes
Equals (eq, EQ) and Not Equals(ne, NE) can be used for case-insensitive string comparisons on
'values'.
This parameter usually requires quoting as shown in the examples here (double quotes around the
entire query parameter, and single-quotes around the {value} field
Use dot-notation to reference attributes that are members of objects contained within the primary
resource object. For example, the following expression would apply a filter on the networkURI
attribute of the connections attribute of the resource:
query="connections.networkURI='/crm-
core/rest/connectionType/9d266036'"
NOTE: Per the RFC , substitute the URL encoding characters for reserved characters that should
not be used in sending requests.
RFC link: http://www.ietf.org/rfc/rfc2396.txt
URL encoding: http://www.w3schools.com/tags/ref_urlencode.asp
More details on Pattern Matching
Example for Equal:
name with value 'Delete alerts.':
https:// {appl} /rest/tasks?query="name EQ 'Delete alerts.'"
Example for Not Equal:
name not equal to 'Delete alerts.':
https:// {appl} /rest/tasks?query="name NE 'Delete alerts.'"
https:// {appl} /rest/tasks?query=NOT "name EQ 'Delete alerts.'"
Example for Lesser then:
percentComplete value lesser then 100:
https:// {appl} /rest/tasks?query="percentComplete LT 100"
Example for Lesser then Equal:
percentComplete lesser then equal to 100:
https:// {appl} /rest/tasks?query="percentComplete LE 100"
Example for Greater then:
percentComplete greater then 100:
https:// {appl} /rest/tasks?query="percentComplete GT 100"
Example for Greater then Equal:
percentComplete Greater then equal to 100:
https:// {appl} /rest/tasks?query="percentComplete GE 100"
Example for IS NULL:
name with value NULL:
https:// {appl} /rest/tasks?query="percentComplete IS NULL"
Example for NOT NULL:
name value without NULL:
https:// {appl} /rest/tasks?query="NOT name EQ NULL"
Example for IN: