This operation updates the status of a console alert.
Request
Syntax
POST <webservice>/Alert/{livefeedId} HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml <update_console_alert_status.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|
livefeedId |
The ID for the console alert. If the ID is not known, use the GET Console Alert API to retrieve it. |
Yes |
Request Headers
|
Name |
Description |
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
Request Body
Download the XML file required for this request: update_console_alert_status.xml. The following table displays the parameters for the request body.
|
Parameter |
Description |
Element |
|
liveFeedId |
The system-generated ID assigned to the console alert. |
updateFeedsList |
|
status |
The status of the alert. Valid values are:
|
updateFeedsList |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
numberOfNewAlert |
The total number of unread alerts. |
App_LiveFeedListResp |
|
liveFeedId |
The system-generated ID assigned to the console alert. |
feedsList |
|
status |
The status of the alert. Valid values are:
|
feedsList |
Examples
Sample Request
This request marks the console alert as "read."
POST <webservice>/Alert/370991 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<App_UpdateLiveFeedListStatusReq>
<updateFeedsList liveFeedId="370991" status="4"/>
</App_UpdateLiveFeedListStatusReq>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_LiveFeedListResp numberOfNewAlert="1020">
<feedsList liveFeedId="370991" status="4"/>
</App_LiveFeedListResp>