RuleResource

REST end point to manipulate individual notification rules.

The following resources are part of this group:

/notification/rule

Mount Point: /dcone/notification/rule

POST

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

Request Body

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

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

Status Codes

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

/notification/rule/{identity}

Mount Point: /dcone/notification/rule/{identity}

The following operations are supported on this resource:

GET

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

Parameters

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

Response Body

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

this end point returns a single rule element

Status Codes

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

PUT

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

Parameters

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

Request Body

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

this end point expects a single rule element containing the notification rule to be updated

Status Codes

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

DELETE

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

Parameters

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

Status Codes

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