WebSphere Business Monitor, Version 6.2 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


Alert - Specific Dashboard Alert Resource - GET Method

Resource URI

GET /alerts/dashboardalerts/{alert id}?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
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.

Request Content

None.

Response Content

Alert data will be localized (according to the query parameters "locale" and "timezoneoffset") before being returned to the client. The following type of data will be localized: Creation Timestamp (datetime).

The default content-type is application/json.

MIME Type: application/json

The following table lists all parameters in the JSON output:

Payload Parameter Name

Type

Description

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

Context Def

string

The context definition

Creation Timestamp

string

The creation time of the binding

Creation Timestamp Localized

string

The creation time of the binding localized

Body

string

The body of the dashboard alert

Event

string

The event associated with the dashboard alert

CBE

string

The Common Base Event associated with the dashboard alert

 


+ View Schema
{ "description": "Dashboard Alert List", 
  "type": "object",
  "properties":
   {
      {
         "ID":{"type":"string"},
         "Subject":{"type":"string"},
         "Acknowledged": {"type":"boolean"},
         "Model ID":{"type":"string"},
         "Context ID":{"type":"string"},
         "Instance ID":{"type":"string"},
	 "Context Def":{"type":"string"},
         "Creation Timestamp":{"type":"string"}, 
         "Creation Timestamp Localized":{"type":"string"},
	 "Body":{"type":"string"},
   	 "Event":{"type":"string"},
   	 "CBE":{"type":"string"}
      }
  }
}

Example content:

{
   "ID":"ABC123",
   "Subject":"Order greater than 5000 received",
   "Acknowledged":false,
   "Model ID":"Model1",
   "Context ID":"Context1", 
   "Instance ID":"ABC123",
   "Context Def":"ABC123",
   "Creation Timestamp":"2007-02-02T15:15:10",
   "Creation Timestamp Localized":"February 2, 2007 3:15:10 PM",
   "Body":"An order was received for 50000",
   "Event":"TheEvent",
   "CBE":"TheCBE"
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{ "description": "REST error response", 
  "type": "object",
  "properties":
   { "Status Code" : {"type":"integer"},
     "Error" : {"type":"string"},
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
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.

Available Since

6.1

Parent Topic: Specific Dashboard Alert Resource