RulesResource

REST end point to manipulate collections of notification rules, notification delivery channel implementations and notifiable events.

The following resources are part of this group:

/notification/channels

Mount Point: /api/notification/channels

GET

This end point gives you the list of all available notification delivery channel implementations.

This list is generated at bootstrap-time from the implementation modules that are present in the application's class path and is immutable.

Response Body

element: channel
media types: application/xml
application/json

this end point returns an array of channel elements

Status Codes

code description
401 Authentication required
403 Authorization required - access forbidden

/notification/events

Mount Point: /api/notification/events

GET

This end point gives you a list of all the types of events that the application is making available for configuring notifications on.

This list is set by the application at bootstrap-time and is immutable.

Response Body

element: eventType
media types: application/xml
application/json

this end point returns an array of eventType elements

Status Codes

code description
401 Authentication required
403 Authorization required - access forbidden

/notification/rules

Mount Point: /api/notification/rules

GET

This end point gives you the list of all the notification rules configured in the application.

Response Body

element: rule
media types: application/xml
application/json

this end point returns an array of rule elements

Status Codes

code description
401 Authentication required
403 Authorization required - access forbidden