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


Alert - Alert Subscriptions Resource - POST (X-METHOD-OVERRIDE=PUT) Method

Use this URI to update alert subscriptions. The X-METHOD-OVERRIDE parameter in the HTTP header needs to be set to PUT. This indicates to the REST service that the PUT method should be used instead of the POST request.

Resource URI

POST /alerts/subscriptions

Parameters

None.

Request Content

The default content-type is application/json.

MIME Type: 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

 

array

Array of all alerts subscriptions

 

Binding ID

boolean

The binding ID

 

Dashboard

boolean

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

 

Cell

boolean

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

 

E-mail

boolean

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

 

Pager

boolean

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

 


+ View Schema
{ "description": "Alert Subscription input list", 
  "type": ["object"],
  "properties":
   {
     "Binding ID":{"type":"string"},
     "Dashboard": {"type":"boolean"},
     "Cell": {"type":"boolean"},
     "E-mail": {"type":"boolean"},
     "Pager": {"type":"boolean"}
  }
}

Example content:

[
   {
      "Binding ID":"ABC123",
      "Dashboard": false,
      "Cell": false,
      "E-mail": true,
      "Pager": false
   }
   {
      "Binding ID":"ABC456",
      "Dashboard": true,
      "Cell": true,
      "E-mail": false,
      "Pager": true
   }   
]

Response Content

None.

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