HP OneView REST API Reference

events
events.html[10/17/2013 10:35:13 AM]
Updated: October 16, 2013 4:08
MDT
API Specifications Create Read Update Delete
/rest/events POST GET
/rest/events/schema GET
/rest/events/{id} GET
Resource Model
EventResourceV2
EventResourceCollectionV2
HP OneView REST API Reference
events
The event resource manager provides REST APIs to create an event resource, or to retrieve or delete one or more event
resources (optionally using filters). An event resource describes a single, low-level problem or life cycle change in a
resource. In many cases the problems are detected by an agent running either on the resource or on the appliance: for
example, an SNMP trap from a ProLiant server's Integrated Lights-Out(iLO) management processor. The event resource is
very simple. It contains a few key fields, such as event type, description, timestamps, and severity. Also, to support wide
variety of event sources, it uses an attribute name/value pair to provide additional event details. For example, the attribute
name "ipv4address" and the attribute value "127.0.0.1" can constitute an attribute name/value pair.
URI: /rest/events
Method API
GET Retrieves a list of event resources (optionally using filter). The response body is an array of event
resources. If no filter is passed in on the URI, all events will be returned.
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0
starts with the first available resource). If the specified count
does not return all resources within the maximum allowed
time (see count), use the start parameter to view additional
resource pages. The default value for start is 0 (first
available resource).
count Optional Optional parameter that specifies the number of resources to
return from each API invocation. The number of resources
returned on each call is referred to as a page. If you specify a
count, the API attempts to return the specified number of
resources, however this may be limited due to response time
constraints and/or actual number of resources available to
return. The results include the total number of resources that
match the filter or query, the actual count returned, and
the URIs to go to the next page, previous page, or both. If
necessary, you can make several requests using the URI for
the next or previous page (or different start parameters) to
get the desired count.
sort Optional The sort order of the returned data set. By default, the sort
order is based on the create time, with the oldest entry first.
view Optional The only supported option for view parameter is
viewDescription. If view=viewDescription is specified the
description details for all the event items is returned.