Retrieve a list of monitor issues according to a preset filter identifier. The filter identifier is shared with the UI's predefined filters. This WebAPI method may also accept ordering details and paging limits.
The response is a list of issue elements with their general details and event-groups identifiers.
Version: 1.2
Required Permissions: Read-only
HTTP method: GET
Supported by Editions: Zend Server
Request Parameters:
Parameter |
Type |
Required |
Description |
filterId |
String |
Yes |
The predefined filter's name. This parameter is case-sensitive. |
limit |
Integer |
No |
The number of rows to retrieve. Default lists all events up to an arbitrary limit set by the system |
offset |
Integer
|
No
|
A paging offset to begin the issues list from. Default is 0 |
order |
String |
No
|
Column identifier for sorting the result set (id, name, repeats, date, eventType, fullUrl, severity, status). Default is date. |
direction |
String |
No
|
Sorting direction: Ascending or Descending. Default is Descending |
filters |
Array |
No |
Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:
|
Expected Response Code: 200 OK. For more information see Response Format.
Response Format: Response successful message or error message
Possible Action Specific Error Codes:
HTTP Code |
Error Code |
Description |
404 |
noSuchFilterId |
The requested filter does not exist |
|
Request
Response
|