getAlertHistory Operation

With getAlertHistory operation you can retrieve all alert logs currently on the TIBCO LogLogic Appliance. You may also use the filters to narrow down the result list.

Request Parameter

authToken, applianceIP, filters

Response

alertHistoryResponse (see alertHistoryResponse Type)

If resultCount is greater than 0 and statusCode is 2000 (successful), the response returns a list of alert logs (total number indicated by resultCount) currently on the remote TIBCO LogLogic Appliance.

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage.

If the appliance is a management station, you may get the aggregated alert logs by specifying “All” in applianceIP.

Example

To retrieve the list of all high priority alert logs on Appliance 1.2.20.100: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:getAlertHistory>
         <aler:authToken>admin+1Y2O2W261O1C1</aler:authToken>
         <aler:applianceIP>1.2.20.100</aler:applianceIP>
         <!--1 or more repetitions:-->
         <aler:filters>/Priority/=/High/</aler:filters>
      </aler:getAlertHistory>
   </soapenv:Body>
</soapenv:Envelope>

To retrieve all alert logs on Appliance 1.2.20.100 with empty filters: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:getAlertHistory>
         <aler:authToken>admin+1Y2O2W261O1C1</aler:authToken>
         <aler:applianceIP>1.2.20.100</aler:applianceIP>
         <!--1 or more repetitions:-->
         <aler:filters></aler:filters>
      </aler:getAlertHistory>
   </soapenv:Body>
</soapenv:Envelope>

To retrieve all new alert logs on Appliance 1.2.20.100: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:getAlertHistory>
         <aler:authToken>admin+1Y2O2W261O1C1</aler:authToken>
         <aler:applianceIP>1.2.20.100</aler:applianceIP>
         <!--1 or more repetitions:-->
         <aler:filters>/Type/=/Unacknowledged/</aler:filters>
      </aler:getAlertHistory>
   </soapenv:Body>
</soapenv:Envelope>

To getAlertHistory for multiple filters: 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:aler="AlertService">
   <soap:Header/>
   <soap:Body>
      <aler:getAlertHistory>
         <!--Optional:-->
         <aler:authToken>admin/admin123</aler:authToken>
         <!--Optional:-->
         <aler:applianceIP>127.0.0.1</aler:applianceIP>
         <!--Zero or more repetitions:-->
         <aler:filters>/Type/=/Unacknowledged/</aler:filters>
         <aler:filters>/Priority/=/High/</aler:filters>
      </aler:getAlertHistory>
   </soap:Body>
</soap:Envelope>
Note: The applianceIP parameter takes one value at a time. To get the result for a specific appliance, you must provide the IP address of that appliance in the <aler:applianceIP> parameter. To get all the results from all the appliances, use the value "All" instead of the appliance IP address. 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:aler="AlertService">
   <soap:Header/>
   <soap:Body>
      <aler:getAlertHistory>
         <!--Optional:-->
         <aler:authToken>admin/admin123</aler:authToken>
         <!--Optional:-->
         <aler:applianceIP>All</aler:applianceIP>
         <!--Zero or more repetitions:-->
         <aler:filters>/Type/=/Unacknowledged/</aler:filters>
         <aler:filters>/Priority/=/Medium/</aler:filters>
      </aler:getAlertHistory>
   </soap:Body>
</soap:Envelope>