EmailDestinationResource

REST end point to manipulate individual channel-specific notification destinations.

The following resources are part of this group:

/notification/channel/email/destination

Mount Point: /api/notification/channel/email/destination

POST

This end point will add a new notification destination to the application.

Request Body

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

this end point expects a single emailDestination element containing the destination to be added

Response Body

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

this end point returns a single emailDestination element containing the destination that was just added

Status Codes

code description
400 The given destination was invalid
401 Authentication required
403 Authorization required - access forbidden

/notification/channel/email/destination/{identity}

Mount Point: /api/notification/channel/email/destination/{identity}

The following operations are supported on this resource:

GET

This end point will return the notification destination that has the given identity.

Parameters

name description type default
identity the ID of the destination to be fetched path

Response Body

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

this end point returns a single emailDestination element

Status Codes

code description
404 Destination with the given ID was not found
401 Authentication required
403 Authorization required - access forbidden

DELETE

This end point will delete the notification destination with the given identity.

Parameters

name description type default
identity the ID of the destination to be deleted path

Status Codes

code description
404 Destination with the given ID was not found
401 Authentication required
403 Authorization required - access forbidden

PUT

This end point will update the notification destination with the given identity.

Parameters

name description type default
identity the ID of the destination to be updated path

Request Body

element: emailDestination
media types: */*
application/xml

this end point expects a single emailDestination element containing the destination to be updated

Response Body

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

this end point returns a single emailDestination element containing the destination that was just updated

Status Codes

code description
400 The given destination was invalid
404 Destination with the given ID was not found
401 Authentication required
403 Authorization required - access forbidden