Event acknowledgement, Post uris path parameters pagination support, Limitations – Brocade Network Advisor REST API Guide (Supporting Network Advisor 12.3.0) User Manual
Page 132
118
Brocade Network Advisor REST API Guide
53-1003160-01
Events
5
Event acknowledgement
Acknowledges or unacknowledges an event.
POST URIs
Path parameters
Pagination support
Brocade Network Advisor supports up to 10 million events. So, retrieval of events is by pages. The
URI for the next page will be returned in the Location header. For paginated collections, the
response will contain the following additional parameters besides the actual list of events:
•
startIndex — The index of the first result returned in this response, relative to the starting
index of all results that would be returned if no startIndex had been requested. In general, this
will be equal to the value requested by the startIndex, or 0 if no specific startIndex was
requested.
•
itemsPerPage — The number of results returned per page in this response. In general, this will
be equal to the count query parameter, but could be less if there are less number of events
than requested left to return when starting at the current startIndex.
•
totalResults — The total number of items that would be returned if there were no startIndex or
count specified. This value tells the user how many total results to expect, regardless of the
pagination in use, but taking into account the current filtering options in the request.
The HTTP status code for a successful execution of a pagination request will be 206 (Partial
Content) if there are more pages to be retrieved. In addition to returning the page of results, the
HTTP response Location header will be populated with the URI for the next page of the response
for a given request. Users may use this URI to navigate to the next page of response.
Limitations
•
Multiple events are not duplicated but stored in the database as a single event with the
property eventCount indicating the number of occurrences of the event and first and last
occurrence times. These events will be returned as is.
•
By default, the results are paginated. The user can use the URI of the next page, returned in
the Location header, to navigate to the next page. However, if the user changes the
parameters of that returned URI of the next page, then the results of the next page may not
match up with that of the previous page.
URI
Description
ledge
Acknowledges a specific event.
owledge
Unacknowledges a specific event.
Name
Description
ekey
Event identifier.