Get Report Request Parameters

The getReport operation common 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 report.

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
reportType Type of report
Note: When you use the value 1, there is no need to create the report in the GUI, in advance. Whereas, when value 3 is used, you need to create and save the report before the web services are called.

Example:

To create real-time report or save the real-time report, create index search or save index search, create index report or save index report.

Possible values:

1—reportName is a Real-Time report template

Example for the value 1: 

<rep:reportType>1
</rep:reportType>
<!--Optional-->
<rep:reportName>userAccess
</rep:reportName>

3—reportName is a name of the custom report

Example for the value 3: 

<rep:reportType>3
</rep:reportType>
<!--Optional-->
<rep:reportName>test1
</rep:reportName>

4—Report is a detail report and the detail report token is specified in the filters

Yes String
reportName Name of the report template or custom report.

The Get Template Report List Operation and Get Custom Report List Operation operations can be used to retrieve the available template report and custom report names, respectively.

For index search: SearchExpressionHits
Note: If the reportName parameter is SearchExpressionHits, then reportType must be 1. But if you create and save one index report or index search, then reportType is 3 and reportName must be the name that you have provided.
Yes String
sourceDeviceName The name of the device, device group, or IP address to use in the report query. Possible values:

“All”, “All Cisco PIX”, or “10.1.1.80”

The default is “All” for all devices, except for custom reports, the default is the device list stored in the custom report.

Note:

This value is only valid if the reportType is selected as 1 (real time report template). If reportType is selected as 3 (saved customized report), the devices list can be retrieved from the system.

Yes, except for custom reports String
timeRange A Pre-defined time range specification, or an indication to use the time range specified by the fromTime and toTime parameters.

If SpecificTime is specified, values for fromTime and toTime must be specified.

Note: If you are not using the logapp wsclient.jar, you must specify the Pre-defined and SpecificTime. You cannot specify NULL value. However, you can specify the current time.

Possible values: Specific time or predefined.

Pre-defined values can be:

  • Last 1 Hour
  • Last 2 Hours
  • Last “n” Hours
  • Yesterday
  • Today

The default is “Last 1 Hour”

Yes Date
fromTime Start time for the time range of the report query.

This parameter is required only if the value for timeRange is a SpecificTime.

See Date/Time Formats for getReport

Example: 

<rep:fromTime>
2019-03-12T
15:38:59.000-07:00
</rep:fromTime>
 
<rep:toTime>2019-03-12T
16:38:59.000-07:00
</rep:toTime>
 No Date
toTime End time for the time range of the report query.

This parameter is required only if the value for timeRange is a SpecificTime.

See Date/Time Formats for getReport No Date
filters List of expressions applied to the query to receive records passing the filter criteria.

For example, for the activeConnections report template, the filter “/direction/=/INBOUND/“ retrieves only inbound connection records.

This is similar functionality as using a “where” clause in SQL.

See the Advanced Options section for the report you specified using the reportName parameter.

For examples of using filters for Index Search or Index Report, see Specifying Filters for Index Searches.

For examples of using filters for Detail Report, see Specifying Filters for Detail Report.

Values must use the format:

Column/Operator/Value

No Array of String
startRow Report query result row to use as the first row of the report result set.

Use the startRow and numberOfRowsToRetrieve to retrieve a specific range of records.

Note: The first row of the query result is zero (0).
A numeric value. Yes Number
numberOf​RowsTo​Retrieve Maximum number of rows to return in the report result set.

Use the startRow and numberOfRowsToRetrieve to retrieve a specific range of records.

A numeric value. Yes Number
sortColumn Column in the generated report to sort on, and the direction of the sort (up or down). Values must use the format:

column-name/direction

where direction is up or down

Example: 

<rep:filters>
Action/down</rep:filters>
<rep:filters>Count/down
</rep:filters>
<rep:filters>
LLDetailTokenRef/down
</rep:filters>
 No String
truncatedMessageLength Defines the maximum message length retrieved from index search. If the message length is more than this limit, the message is truncated at the maximum message length and ended with <ll-trunc>.

The default value is 100.

If truncatedMessageLength is less than 100, it is set to 100 (the maximum message length).

If truncatedMessageLength is less than -1, there is no limitation to the message length.

Yes Number

Example SOAP request for sortColumn: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="ReportService">
   <soapenv:Header/>
   <soapenv:Body>
      <rep:getReport>
         <!--Optional:-->
         <rep:authToken>admin/admin123</rep:authToken>
         <!--Optional:-->
         <rep:applianceIP>10.114.81.43</rep:applianceIP>
         <rep:reportType>3</rep:reportType>
         <!--Optional:-->
         <rep:reportName>test1</rep:reportName>
         <!--Optional:-->
         <rep:sourceDeviceName>ALL</rep:sourceDeviceName>
         <!--Optional:-->
         <rep:timeRangeType>Last 1 Hour</rep:timeRangeType>
         <!--Optional:-->
         <rep:fromTime></rep:fromTime>
         <!--Optional:-->
         <rep:toTime></rep:toTime>
         <!--Optional:-->
         <rep:sortColumn></rep:sortColumn>
         <!--Zero or more repetitions:-->
         <rep:filters></rep:filters>
         <rep:startRow>0</rep:startRow>
         <rep:numberRowsToRetrieve>1111</rep:numberRowsToRetrieve>
      </rep:getReport>
   </soapenv:Body>
</soapenv:Envelope>

Example SOAP request response: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getReportResponse xmlns:ns="ReportService">
         <ns:return xsi:type="ax225:ReportResultSet" xmlns:ax225="http://report.services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax225:columnNames xsi:type="ax225:ReportColumns">
               <ax225:columnCount>6</ax225:columnCount>
               <ax225:columns>Source Device</ax225:columns>
               <ax225:columns>User</ax225:columns>
               <ax225:columns>Action</ax225:columns>
               <ax225:columns>Status</ax225:columns>
               <ax225:columns>Count</ax225:columns>
               <ax225:columns>LLDetailTokenRef</ax225:columns>
            </ax225:columnNames>
            <ax225:endTime>2019-03-12T16:22:04.000-07:00</ax225:endTime>
            <ax225:errorCause>0</ax225:errorCause>
            <ax225:errorCode>0</ax225:errorCode>
            <ax225:records xsi:type="ax225:ReportRecords">
               <ax225:recordCount>1</ax225:recordCount>
               <ax225:theRecords xsi:type="ax225:Record">
                  <ax225:columnValues>::ffff:10.114.81.43_otherUnix</ax225:columnValues>
                  <ax225:columnValues></ax225:columnValues>
                  <ax225:columnValues>Sudo</ax225:columnValues>
                  <ax225:columnValues>Success</ax225:columnValues>
                  <ax225:columnValues>674</ax225:columnValues>
                  <ax225:columnValues>dXNlckFjY2Vzc0RldGFpbCw6OmZmZmY6MTAuMTE0LjgxLjQzX290aGVyVW5peCwsZGV2aWNlTmFtZSw6OmZmZmY6MTAuMTE0LjgxLjQzX290aGVyVW5peCx1c2VyLC0tbnVsbC0tLHVzZXJBY3Rpb24sU3VkbyxzdGF0dXMsU3VjY2Vzcyxjb3VudCw2NzQsZGV2aWNlVHlwZSxhbGwsdGVzdDE=</ax225:columnValues>
               </ax225:theRecords>
            </ax225:records>
            <ax225:reportName>test1</ax225:reportName>
            <ax225:startTime>2019-03-12T15:22:04.000-07:00</ax225:startTime>
         </ns:return>
      </ns:getReportResponse>
   </soapenv:Body>