WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
GET /alerts/dashboardalerts?{parameters}
Name | Value Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
locale | string |
The locale. This value consists of lowercase ISO language
code (ISO 639) and the uppercase ISO country code (ISO 3166) joined by an
underscore (for example, en_US). Results will be returned in the locale specified.
If no locale is specified, the locale of the REST server will be used.
|
||||||
timezoneoffset | integer |
The amount of time in minutes to add to or subtract from the Greenwich
Mean Time (GMT) time in order to get the local time. The timezone offset
will be applied to the "localized" value for Creation Timestamp.
|
||||||
page | integer |
Page to retrieve. Use -1 to indicate all
subscriptions on a single-page request.
|
||||||
pagesize | integer |
The number of items per page. If this value is not
provided, the default of 10 is used.
|
||||||
sortby | string |
The column used to sort alerts. Valid values are 'Acknowledged',
'Creation Timestamp', 'Instance ID', 'Context ID', 'Model ID',
and 'Subject'.
|
||||||
order | string |
The order in which the sort should be conducted.
Valid values are 'asc' and 'desc'.
|
None.
The default content-type is application/json.
The HTTP request can have a payload which contains parameters. The following table lists all input parameters that can be sent in the HTTP payload in JSON format.
Parameter Name |
Type |
Description |
|
Record Count |
number |
The total record count |
|
Page Size |
number |
The number of records on each page |
|
Page Number |
number |
The page number |
|
Dashboard Alert Array |
array |
Array of all dashboard alerts |
|
|
ID |
string |
The ID of the dashboard alert |
|
Subject |
string |
The dashboard alert subject |
|
Acknowledged |
boolean |
Indicates whether the dashboard alert has been acknowledged |
|
Model ID |
string |
The monitor model ID |
|
Context ID |
string |
The context ID |
|
Instance ID |
string |
The instance ID |
|
Creation Timestamp |
string |
The creation time of the binding |
|
Creation Timestamp Localized |
string |
The creation time of the binding localized |
{ "description": "Dashboard Alert List", "type": "object", "properties": { "Dashboard Alert Array": [ { "ID":{"type":"string"}, "Subject":{"type":"string"}, "Acknowledged": {"type":"boolean"}, "Model ID":{"type":"string"}, "Context ID":{"type":"string"}, "Instance ID":{"type":"string"}, "Creation Timestamp":{"type":"string"}, "Creation Timestamp Localized":{"type":"string"}, } ], "Record Count":{"type":"integer"}, "Page Size":{"type":"integer"}, "Page Number":{"type":"integer"} } }
Example content:
{ "Dashboard Alert Array": [ { "ID":"ABC123", "Subject":"Order received", "Acknowledged":true, "Model ID":"Model1", "Context ID":"ABC123", "Instance ID":"123456", "Creation Timestamp":"2008-09-02T15:15:10", "Creation Timestamp Localized":"September 2,2008 3:15:10 PM", } { "ID":"ABC456", "Subject":"Order shipped", "Acknowledged":true, "Model ID":"Model1", "Context ID":"ABC456", "Instance ID":"345678", "Creation Timestamp":"2008-09-15T08:30:00", "Creation Timestamp Localized":"September 15,2008 8:30:00 AM", } ], "Record Count":2, "Page Size":10, "Page Number":1 }
The default content-type is application/json.
{ "description": "REST error response", "type": "object", "properties": { "Status Code" : {"type":"integer"}, "Error" : {"type":"string"}, } }
Code | Description |
---|---|
200 OK |
Successful completion - requested data returned. Note that the list may be empty.
|
404 Not Found |
Resource not found or URL not supported.
|
400 Bad Request |
The request contains invalid parameters or is missing parameters and inputs.
|
500 Internal Server Error |
Internal error processing the request.
|
6.1
Parent Topic: Dashboard Alert List Resource