Alert



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/alerts

Summary


Resources Methods
https://localhost:8443/api/rest/alerts

GET  Retrieves the list of 'live' alerts.

POST  Creates a subscription to alerts the user is authorized to view.

https://localhost:8443/api/rest/alerts/{alert-identifier}

GET  Retrieves information about an alert.

Resources


https://localhost:8443/api/rest/alerts


Methods

GET


Retrieves the list of 'live' alerts.

[tags: DMA]

Request

Query Parameters

Name Type Description
limit xs:int
Limit the number of users returned to this number, even if more results match the query.
Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used.
Note 2: If the limit value is less than or equal to 0, the default of 500 will be used.
Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.
page xs:int
When limiting the results, this specifies which page/subset of data to view.
Note 1: The valid integer range is 1 to 2147483647.
Note 2: If the page value is less than or equal to 0, the default of 1 will be used.
Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-alert-list+xml
application/vnd.plcm.plcm-alert-list+json
Alerts successfully retrieved.
304
Alerts have not changed since the last get.

Note: The API client must provide the "plcm-alert-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-alert-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the network clouds on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: administrator, provisioner

POST


Creates a subscription to alerts the user is authorized to view. The consumer must implement plcm-alert-observer.wadl.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-subscription+xml
application/vnd.plcm.plcm-subscription+json

Response

Status Representation Description
201 Subscription created successfully
400 text/plain
Bad request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Time-To-Live is out of range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or
any integer between 1 and 93600 (26 hours) in seconds.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Inaccessible subscription consumer URL. Expect 200 when sending HTTPS GET request to the URL.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Malformed subscription consumer URL.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Only HTTPS subscription consumer URL is allowed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The same user cannot subscribe to the same resource with the same consumer URL more than once.

https://localhost:8443/api/rest/alerts/{alert-identifier}


Template Parameters

Name Type Description
alert-identifier xs:string Alert identifier

Methods

GET


Retrieves information about an alert.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-alert+xml
Alert information successfully retrieved.
304
Alert information has not changed since the last retrieval.
Note: The API client must provide the "plcm-alert" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical single user retrieval in the "If-None-Match" header, then
the HTTP response will contain the user representation in the message
body.

The "plcm-alert" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical alert-identifier
to ensure an equivalent ETag value. This also assumes no other client made changes to
alerts on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator, provisioner.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such alert