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
JsonSchema The JSON schema of the alert object.
Response Codes
REST API Response Codes
Examples
GET https://{appl}/rest/alerts/schema
URI: /rest/alerts/{id}
Method API
DELETE Deletes a single alert resource identified by its ID. The user can optionally specify the ETag in the
If-Match header of the request. If the Etag is specified, then the alert is modified only if the
current Etag of the resource matches the value of Etag specified. An Etag value that is *, null or
empty is ignored.
Parameter Attributes Description
force Optional If set to true, the operation completes even if there are network
connectivity issues or resource errors. The default is false.
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 https://{appl}/rest/alerts/{id}
The above example deletes the alert which matches the
unique identifier specified.
GET Retrieves a single alert resource identified by its ID. Returns the Etag value of the resource in the
response body and in the Etag Response header.
Parameter Attributes Description
view Optional Return a specific subset of the attributes of the resource or collection
by specifying the name of a predefined view. The default view is
expand (show all attributes of the resource, and all elements of
collections or resources).