NotificationPolicyController Resource

GET /notification-policies

Return details of all Notification Polices

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of NotificationPolicyDetail (JSON) list of detailed Notification Policies

Example

Request
GET /notification-policies
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

POST /notification-policies

Create a new Notification Policy

Request Body
media type data type description
application/json NotificationPolicyRequest (JSON) specify data for new Notification Policy
Response Body
media type data type description
application/json NotificationPolicyDetail (JSON) details of newly created Notification Policy

Example

Request
POST /notification-policies
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

POST /notification-policies/preview

Request Body
media type data type
application/json NotificationPolicyRequest (JSON)
Response Body
media type data type description
application/json array of NotificationPushPreview (JSON)

Example

Request
POST /notification-policies/preview
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ { } ]

DELETE /notification-policies/{guid}

Delete Notification Policy

Request Parameters
name type description
guid path specify local unique identifier for Notification Policy

Example

Request
DELETE /notification-policies/{guid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /notification-policies/{guid}

Return detail of single Notification Policy

Request Parameters
name type description
guid path specify local unique identifier for Notification Policy
Response Body
media type data type description
application/json NotificationPolicyDetail (JSON) detail of single Notification Policy

Example

Request
GET /notification-policies/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /notification-policies/{guid}

Update an existing Notification Policy

Request Parameters
name type description
guid path specify local unique identifier for Notification Policy
Request Body
media type data type description
application/json NotificationPolicyRequest (JSON) specify data for updating Notification Policy
Response Body
media type data type description
application/json NotificationPolicyDetail (JSON) updated detail of Notification Policy

Example

Request
PUT /notification-policies/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }