Get Detail Report Meta Info Operation

The getDetailReportMetaInfo command performs the same functionality as getReportMetaInfo. However, instead of ReportType/LogSource, it takes an LLDetailTokenRef string as input to retrieve the report column metadata.

Note: Only displayed columns in a custom report will be returned, not all columns.

Get Detail Report Meta Info Request Parameter

The getDetailReportMetaInfo operation request parameters are:

Parameter Description Values Required Type
authToken Token string returned from the authentication service or the “username/password”.   Yes String
applianceIP The appliance from which you retrieve the metadata.

If the value is blank, it retrieves the Appliance IP address from the local Appliance.

This parameter is applicable for Management Station Appliances only.

IP address of a managed Appliance or All for retrieving an aggregated report from all managed Appliances. To specify an IP address, use the standard IP address format. For example:

10.1.2.3

No String
LLDetailTokenRef The detail report token reference. The detail token string received in previous getReport operation. Yes String

Example

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

Get Detail Report Meta Info Response Attributes

The getDetailReportMetaInfo response attributes are:

Attribute Description Type
errorCode Error code for the request number. Number
errorCause Error cause code of the error. Number
columnCount Number of columns returned in the report. Number
columnInfo An array of reportColumnInfo (complex type).

reportColumnInfo is a structure containing:

displayName (string)

shortDisplayName (string)

internalName (string)

columnType (string)

Array

Example

SOAP response for getDetailReportMetaInfo response attributes: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getDetailReportMetaInfoResponse xmlns:ns="ReportService">
         <ns:return xsi:type="ax225:ReportMetaInfo" xmlns:ax225="http://report.services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax225:columnCount>6</ax225:columnCount>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>string</ax225:columnType>
               <ax225:displayName>Time</ax225:displayName>
               <ax225:internalName>time</ax225:internalName>
               <ax225:shortDisplayName>Time</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>ip_address</ax225:columnType>
               <ax225:displayName>Device IP</ax225:displayName>
               <ax225:internalName>deviceIp</ax225:internalName>
               <ax225:shortDisplayName>Device IP</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>string</ax225:columnType>
               <ax225:displayName>Device Source</ax225:displayName>
               <ax225:internalName>sourceName</ax225:internalName>
               <ax225:shortDisplayName>Device Source</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Facility</ax225:displayName>
               <ax225:internalName>facility</ax225:internalName>
               <ax225:shortDisplayName>Facility</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>name</ax225:columnType>
               <ax225:displayName>Severity</ax225:displayName>
               <ax225:internalName>severity</ax225:internalName>
               <ax225:shortDisplayName>Severity</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:columnInfo xsi:type="ax225:ReportColumnInfo">
               <ax225:columnType>string</ax225:columnType>
               <ax225:displayName>Message</ax225:displayName>
               <ax225:internalName>message</ax225:internalName>
               <ax225:shortDisplayName>Message</ax225:shortDisplayName>
            </ax225:columnInfo>
            <ax225:errorCause>0</ax225:errorCause>
            <ax225:errorCode>0</ax225:errorCode>
         </ns:return>
      </ns:getDetailReportMetaInfoResponse>
   </soapenv:Body>
</soapenv:Envelope>