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


Alert - Alert Subscriptions Resource - GET Method

Use this URI to retrieve a list of available alert subscriptions.

Resource URI

GET /alerts/subscriptions?{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.
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 sort column. Valid values are 'Category', 'Cell', 'Creation Timestamp', 'Dashboard', 'Description', 'E-mail', 'Name', and 'Pager'.
order string
The order in which the sort should be conducted. Valid values are 'asc' and 'desc'.
ValueDescription
asc (default)
Sort alert subscriptions by the sort column in ascending order.
desc
Sort alert subscriptions by the sort column in descending order.

Request Content

None.

Response Content

Subscription 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:

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

Alert Subscription Array

array

Array of all alert subscriptions

 

Binding ID

string

The binding ID

 

Name

string

The binding name

 

Description

string

The description of the binding

 

Category

string

The category of the binding

 

Creation Timestamp

string

The creation time of the binding

 

Creation Timestamp Localized

string

The creation time of the binding localized

 

Dashboard

boolean

Indicates whether the use is subscribed to dashboard alerts for the given binding

 

Cell

boolean

Indicates whether the use is subscribed to cell alerts for the given binding

 

E-mail

boolean

Indicates whether the use is subscribed to e-mail alerts for the given binding

 

Pager

boolean

Indicates whether the use is subscribed to pager alerts for the given binding

 


+ View Schema
{ "description": "Alert Subscription List", 
  "type": "object",
  "properties":
   {
   	"Alert Subscription Array": 
		[
                   {
                      "Binding ID":{"type":"string"},
                      "Name":{"type":"string"},
                      "Description":{"type":"string"},
                      "Category":{"type":"string"},
                      "Creation Timestamp":{"type":"string"}, 
                      "Creation Timestamp Localized":{"type":"string"},
                      "Dashboard": {"type":"boolean"},
                      "Cell": {"type":"boolean"},
                      "E-mail": {"type":"boolean"},
                      "Pager": {"type":"boolean"}
                   }
                 ],
   	"Record Count":{"type":"integer"},
   	"Page Size":{"type":"integer"},
   	"Page Number":{"type":"integer"}
  }
}

Example content:

{
   "Alert Subscription Array": [
                                 {
                                   "Binding ID":"ABC123",
                                   "Name":"Test Situation Binding",
                                   "Description":"Binding for testing",
                                   "Category":"Test",
                                   "Creation Timestamp":"2007-02-02T15:15:10", 
                                   "Creation Timestamp Localized":"February 2,2007 3:15:10 PM",
                                   "Dashboard": true,
                                   "Cell": false,
                                   "E-mail": false,
                                   "Pager": false
                                 }
                                 {
                                   "Binding ID":"ABC456",
                                   "Name":"Test Situation Binding",
                                   "Description":"2nd Binding for testing",
                                   "Category":"2nd Test",
                                   "Creation Timestamp":"2008-09-15T08:30:00", 
                                   "Creation Timestamp Localized":"September 15,2008 8:30:00 AM",
                                   "Dashboard": false,
                                   "Cell": false,
                                   "E-mail": true,
                                   "Pager": true
                                 }
                               ],
   "Record Count":2,
   "Page Size":10,
   "Page Number":1
}

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: Alert Subscriptions Resource