getList Operation

With getList operation you can retrieve a list of all device groups currently configured for the TIBCO LogLogic Appliance. This returns all device groups, not just enabled device groups.

Request Parameter

authToken

Response

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

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

Example

To list all device groups currently configured for the Appliance: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dev="DeviceGroupService">
   <soapenv:Header/>
   <soapenv:Body>
      <dev:getList>
         <!--Optional:-->
         <dev:authToken>admin/admin123</dev:authToken>
      </dev: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="DeviceGroupService">
         <ns:return xsi:type="ax211:DeviceGroupResponse" xmlns:ax211="http://devicegroup.services.logapp.loglogic.com/xsd" xmlns:ax212="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax212:authToken xsi:nil="true"/>
            <ax212:resultCount>5</ax212:resultCount>
            <ax212:statusCode>2000</ax212:statusCode>
            <ax212:statusMessage>Successful</ax212:statusMessage>
            <ax212:summaryOnly>true</ax212:summaryOnly>
            <ax211:resultSet xsi:type="ax211:DeviceGroupDetail">
               <ax211:description>All Other UNIX</ax211:description>
               <ax211:deviceGroupName>All Other UNIX</ax211:deviceGroupName>
               <ax211:devices xsi:nil="true"/>
               <ax211:enabled>enabled</ax211:enabled>
               <ax211:groupType>local</ax211:groupType>
            </ax211:resultSet>
            <ax211:resultSet xsi:type="ax211:DeviceGroupDetail">
               <ax211:description>All LogLogic Logu</ax211:description>
               <ax211:deviceGroupName>All LogLogic Logu</ax211:deviceGroupName>
               <ax211:devices xsi:nil="true"/>
               <ax211:enabled>enabled</ax211:enabled>
               <ax211:groupType>local</ax211:groupType>
            </ax211:resultSet>
            <ax211:resultSet xsi:type="ax211:DeviceGroupDetail">
               <ax211:description>All Cisco ASA</ax211:description>
               <ax211:deviceGroupName>All Cisco ASA</ax211:deviceGroupName>
               <ax211:devices xsi:nil="true"/>
               <ax211:enabled>enabled</ax211:enabled>
               <ax211:groupType>local</ax211:groupType>
            </ax211:resultSet>
            <ax211:resultSet xsi:type="ax211:DeviceGroupDetail">
               <ax211:description>All LogLogic Appliance</ax211:description>
               <ax211:deviceGroupName>All LogLogic Appliance</ax211:deviceGroupName>
               <ax211:devices xsi:nil="true"/>
               <ax211:enabled>enabled</ax211:enabled>
               <ax211:groupType>local</ax211:groupType>
            </ax211:resultSet>
            <ax211:resultSet xsi:type="ax211:DeviceGroupDetail">
               <ax211:description>All General Syslog</ax211:description>
               <ax211:deviceGroupName>All General Syslog</ax211:deviceGroupName>
               <ax211:devices xsi:nil="true"/>
               <ax211:enabled>enabled</ax211:enabled>
               <ax211:groupType>local</ax211:groupType>
            </ax211:resultSet>
         </ns:return>
      </ns:getListResponse>
   </soapenv:Body>
</soapenv:Envelope>