HP OneView REST API Reference

alerts
alerts.html[10/17/2013 10:35:10 AM]
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
AlertResourceV2 The alert that is represented by the ID.
Response Codes
REST API Response Codes
Examples
GET https://{appl}/rest/alerts/{id}
The above example retrieves the alert which matches the
unique identifier specified.
PUT Modifies the attributes of a single alert. Attributes that can be updated include: alertState,
alertUrgency, assignedToUser, and the notes of an alert passed in the Request Body as
"attributeName":"value" pairs. If an "eTag" attribute is specified in the request body or in the if-
Match header, then the alert will be modified only if the current eTag of the resource matches the
value of eTag specified. After a new notes field is passed in, a corresponding new
AlertChangeLog is created. Only the properties included in the request body are modified. If the
operation succeeds, the Etag value of the resource is returned in the response body and in the
Etag Response header.
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"
Request
Body
Attributes Description
Map Required The properties to be modified. Valid values are
alertState,
alertUrgency, assignedToUser or notes. You can
specify an eTag
to pick the right version of alert to modify.
An eTag value
that is *, null, or empty will be ignored. An
example request
body is included in the example that follows.
Response Description
AlertResourceV2 The updated alert object. If no changes are made to
the alert
then nothing is returned.
Response Codes
REST API Response Codes
Examples
PUT https://{appl}/rest/alerts/{id}
A sample request body is shown below: