acknowledgeAlertHistoryByKey Operation

With acknowledgeAlertHistoryByKey operation you can acknowledge a list of alert logs currently on the TIBCO LogLogic®TIBCO LogLogic appliance. You have to obtain the key list from getAlertHistory operation.

If you have obtained a list from the aggregated alert logs, you must specify “All” in applianceIP. Otherwise, it will be processed in single appliance mode and only alert logs on current appliance will be affected.

If resultCount is not 0, it means there are invalid keys in your key list. You can browse the returned resultSet for these keys.

Request Parameter

authToken, applianceIP, keyList

Response

alertHistoryResponse (see alertHistoryResponse Type)

Example

To acknowledge one or more alert logs on the appliance 1.2.20.100: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:acknowledgeAlertHistoryByKey>
         <aler:authToken>admin+1Y2O2W261O1C1J1X29</aler:authToken>
         <aler:applianceIP>1.2.20.100</aler:applianceIP>
         <!--1 or more repetitions:-->
         <aler:keyList>10:2:1515009786:1.2.20.100</aler:keyList>
      </aler:acknowledgeAlertHistoryByKey>
   </soapenv:Body>
</soapenv:Envelope>

To acknowledge multiple alerts at a time, you need to add multiple key elements, as shown below: 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:aler="AlertService">
   <soap:Header/>
   <soap:Body>
      <aler:acknowledgeAlertHistoryByKey>
         <!--Optional:-->
         <aler:authToken>user/password</aler:authToken>
         <!--Optional:-->
         <aler:applianceIP>All</aler:applianceIP>
         <!--Zero or more repetitions:-->
         <aler:keyList>9:1:1552273720:10.114.81.43</aler:keyList>
         <aler:keyList>8:1:1552273660:10.114.81.43</aler:keyList>
         <aler:keyList>7:1:1552273600:10.114.81.43</aler:keyList>
      </aler:acknowledgeAlertHistoryByKey>
   </soap:Body>
</soap:Envelope>

SOAP response for the acknowledgeAlertHistoryByKey Operation: 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:acknowledgeAlertHistoryByKeyResponse xmlns:ns="AlertService">
         <ns:return xsi:type="ax27:AlertHistoryResponse" xmlns:ax27="http://alert.services.logapp.loglogic.com/xsd" xmlns:ax28="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax28:authToken xsi:nil="true"/>
            <ax28:resultCount>0</ax28:resultCount>
            <ax28:statusCode>2000</ax28:statusCode>
            <ax28:statusMessage>Successful</ax28:statusMessage>
            <ax28:summaryOnly>true</ax28:summaryOnly>
         </ns:return>
      </ns:acknowledgeAlertHistoryByKeyResponse>
   </soapenv:Body>
</soapenv:Envelope>