Get Custom Report List Operation

The getCustomReportList operation returns a list of the custom reports configured in the Appliance.

Get Custom Report List Request Parameter

The getCustomReportList operation request parameter are:

Parameter Description Values Required Type
authToken

Token string returned from the authentication service or the “username/password”.

  Yes String

Example

SOAP request for getCustomReportList Request parameter: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="ReportService">
   <soapenv:Header/>
   <soapenv:Body>
      <rep:getCustomReportList>
         <!--Optional:-->
         <rep:authToken>admin/admin123</rep:authToken>
      </rep:getCustomReportList>
   </soapenv:Body>
</soapenv:Envelope>

Get Custom Report List Response Attributes

The getCustomReportList response attributes are:

Attribute Description Type
errorCode Error code for the request number. Number
recordCount Number of custom report names. Number
reportList An array of reportTitle (string) and reportType (string). The custom report’s reportTitle value can be used in the getReport operation’s reportName parameter. Array

Example

SOAP response for getCustomReportList Response attributes: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getCustomReportListResponse xmlns:ns="ReportService">
         <ns:return xsi:type="ax225:ReportListResponse" xmlns:ax225="http://report.services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax225:errorCause>0</ax225:errorCause>
            <ax225:errorCode>0</ax225:errorCode>
            <ax225:recordCount>1</ax225:recordCount>
            <ax225:reportList xsi:type="ax225:ReportListItemDetail">
               <ax225:reportTitle>dddd</ax225:reportTitle>
               <ax225:reportType>userAccess</ax225:reportType>
            </ax225:reportList>
         </ns:return>
      </ns:getCustomReportListResponse>
   </soapenv:Body>
</soapenv:Envelope>