NotificationsAuxiliaryResource
Copyright 2014 WANdisco.
Auxiliary notification REST API. Extra functionality, not present in notification framework but only needed for ACP application.
The following resources are part of this group:
/notification/aux
Mount Point: /dcone/notification/aux
POST
Enables or disables all notifications. Note, the creation of arbitrary notification rules is not exposed in this version of ACP. Enabling and disabling of notifications only relates to default rules that admin cannot control.
Parameters
| name | description | type | default |
|---|---|---|---|
| enable | true - notifications will be enabled, false - notifications will be disabled | query | false |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
responses 500, 409, 202, 200
Status Codes
| code | description |
|---|---|
| 500 | Unknown notification email channel or event |
| 409 | Attempted to create notification rule with bad data |
| 202 | The requested operation will be performed aynchroneously |
| 200 | The requested operation is already performed |
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | id |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/notification/aux/gateways
Mount Point: /dcone/notification/aux/gateways
GET
Returns a list of all email gateways currently present. Note: passwords have been removed from DTOs
Response Body
| element: | gateway |
| media types: | application/xml application/json |
list of gateways without password values
/notification/aux/isenabled
Mount Point: /dcone/notification/aux/isenabled
GET
Tells if notifications are currently enabled or disabled
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
true - notifications are enabled, false - notifications are disabled
Status Codes
| code | description |
|---|---|
| 500 | Unknown notification email channel or event |
| 200 | The requested operation is performed, answer is embedded |
/notification/aux/{id}
Mount Point: /dcone/notification/aux/{id}
DELETE
Parameters
| name | description | type | default |
|---|---|---|---|
| id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| id | (no documentation provided) | path | |
| queryEnforced | (no documentation provided) | query | false |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)