getList Operation

With getList operation you can retrieve the complete list of all alerts currently defined in the TIBCO LogLogic Appliance.

Request Parameter

authToken

Response

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

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage. Following is the example with invalid user name and password: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getListResponse xmlns:ns="AlertService">
         <ns:return xsi:type="ax27:AlertResponse" 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>4000</ax28:statusCode>
            <ax28:statusMessage>Login failed with error 1</ax28:statusMessage>
            <ax28:summaryOnly>false</ax28:summaryOnly>
            <ax27:resultSet xsi:nil="true"/>
         </ns:return>
      </ns:getListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Example

SOAP request for getList Operation. To retrieve a list of all alerts defined in the Appliance: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:getList>
         <aler:authToken>admin+1Y2O2W261O1C1J1X294</aler:authToken>
      </aler:getList>
   </soapenv:Body>
</soapenv:Envelope>
SOAP response for getList Operation: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getListResponse xmlns:ns="AlertService">
         <ns:return xsi:type="ax27:AlertResponse" 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>7</ax28:resultCount>
            <ax28:statusCode>2000</ax28:statusCode>
            <ax28:statusMessage>Successful</ax28:statusMessage>
            <ax28:summaryOnly>true</ax28:summaryOnly>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>AlertCriteria/Disk Usage//Drive/%2F//HighThreshold/80</ax27:alertRules>
               <ax27:alertType>System Alert</ax27:alertType>
               <ax27:desc>System Alert - Disk Usage</ax27:desc>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>System Alert - Disk Usage</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>High</ax27:priority>
               <ax27:resetTime>1800</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackIndividualDevice>no</ax27:trackIndividualDevice>
               <ax27:users>admin</ax27:users>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>AlertCriteria/Dropped-Message//HighThreshold/10</ax27:alertRules>
               <ax27:alertType>System Alert</ax27:alertType>
               <ax27:desc>System Alert - Dropped Message</ax27:desc>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>System Alert - Dropped Message</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>High</ax27:priority>
               <ax27:resetTime>1800</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackIndividualDevice>no</ax27:trackIndividualDevice>
               <ax27:users>admin</ax27:users>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>AlertCriteria/Emergency Disk Usage</ax27:alertRules>
               <ax27:alertType>System Alert</ax27:alertType>
               <ax27:desc>System Alert - Emergency Disk Usage</ax27:desc>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>System Alert - Emergency Disk Usage</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>High</ax27:priority>
               <ax27:resetTime>900</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackIndividualDevice>no</ax27:trackIndividualDevice>
               <ax27:users>admin</ax27:users>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>AlertCriteria/Engine Status</ax27:alertRules>
               <ax27:alertType>System Alert</ax27:alertType>
               <ax27:desc>System Alert - Engine Status</ax27:desc>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>System Alert - Engine Status</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>High</ax27:priority>
               <ax27:resetTime>900</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackIndividualDevice>no</ax27:trackIndividualDevice>
               <ax27:users>admin</ax27:users>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>AlertCriteria/Fail-over</ax27:alertRules>
               <ax27:alertType>System Alert</ax27:alertType>
               <ax27:desc>System Alert - Fail Over</ax27:desc>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>System Alert - Fail Over</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>High</ax27:priority>
               <ax27:resetTime>1800</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackIndividualDevice>no</ax27:trackIndividualDevice>
               <ax27:users>admin</ax27:users>
            </ax27:resultSet>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>AlertCriteria/Data Migration complete</ax27:alertRules>
               <ax27:alertType>System Alert</ax27:alertType>
               <ax27:desc>System Alert - Migration Complete</ax27:desc>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>System Alert - Migration Complete</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>High</ax27:priority>
               <ax27:resetTime>3600</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackInd>