HP OneView REST API Reference

alerts
alerts.html[10/17/2013 10:35:10 AM]
filter Experimental A general filter string to narrow the list of resources to be deleted by
a multi-resource DELETE (delete) request. The default is no filter
(all resources are deleted). The filter parameter is based on the URI
Filter Language.
NOTE: Do NOT use the filter usage defined under standard
parameters documentation. The format and usage of this filter
parameter is similar to that of the query parameter documented
under standard parameters.
Format:
filter="{attribute} {operator} '{value}'"
filter="{attribute} {operator} '{value}'"{multi-filter operator}filter="
{attribute} {operator} '{value}'"
• {attribute}: the resource attribute being filtered (e.g., model,
platform, etc.)
• {operator}: one of [ EQ, NE, GT, GE, LE, LT, LIKE, IS NULL, AND,
OR , IN ]
• {value}: the value of the attribute being filtered. For LIKE this is an
expression string, supports SQL wildcard.
• {multi-filter operator}: &
It is not necessary to use multiple filter expressions since it is
possible to combine multiple filter expressions into a single one
using the AND operator available in URI Filter Language.
All the URI Filter Language based query strings described in the
examples for the query parameter works well for filter parameter. In
addition, the filter parameter supports multiple filters in the same
request.
For example: filter="alertState EQ 'Active'"&filter="severity EQ
'Critical'"
Filter usage examples:
DELETE https://{appl}/rest/alerts?filter="alertState EQ 'Active'"
DELETE https://{appl}/rest/alerts?filter="alertState EQ
'Active'"&filter="severity EQ 'Warning'"
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
void Does not return any value.
Response Codes
REST API Response Codes
Examples
DELETE