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: /api/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
401 Authentication required.
403 Authorization required - access forbidden

GET

Retrieve paged list of access control objects

Parameters

name description type default
queryEnforced "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. query false
pageSize number of entries per page query 20
pageNumber page to return query 1
fieldList list of fields to be populated in returned DTOs query
sortAscending "true" if results should be sorted ascending query true
sortColumn column name to perform sort by query id
searchKeyList list of keys to search by query
searchValueList list of values to search for query

Response Body

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

a PagedResultListDTO of returned DTOs

Status Codes

code description
200 OK
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/notification/aux/gateways

Mount Point: /api/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

Status Codes

code description
401 Authentication required.
403 Authorization required - access forbidden

/notification/aux/isenabled

Mount Point: /api/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
401 Authentication required.
403 Authorization required - access forbidden

/notification/aux/{id}

Mount Point: /api/notification/aux/{id}

DELETE

Deletes an access control object

Parameters

name description type default
id ID of the model object to delete path

Response Body

element: (custom)
media types: */*
application/xml

ID of the task monitoring the deletion

Status Codes

code description
202 Accepted - proposed
404 Not found - see returned ExceptionDTO
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

GET

Retrieves an access control object

Parameters

name description type default
id ID of the object to be retrieved path
queryEnforced "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. query false

Response Body

element: (custom)
media types: application/xml
application/json

a DTO representation of the object

Status Codes

code description
200 OK
404 Not found - see returned ExceptionDTO
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden