SOAP API - GetRenderedCustomReport

GetRenderedCustomReport( ownerID, reportName, filters ) : Object[]

Since: EngageIP v25.2

Retrieves data from a custom report

The data returned from this method call is an array of objects of an undetermined type. The objects returned will have property names that reflect the field names in the custom report and each object in the array will represent a row of data from the custom report.

myResultEntry.myReportFieldName = "My Report Value";
myResultEntry.myOtherReportFieldName = "My Other Report Value";

Filters can also be applied to the custom report via the method's filters parameter which must be in the format of "name=value" pairs, delimiting multiple filters by using a semi-colon ';'

Parameters:

ownerID (Integer) - The ID of the owner for which this report belongs. An exception will be thrown if the ID does not exist.
reportName (String) - The name of the custom report to be retrieved. An exception will be thrown if the name does not exist for the specified owner.
filters (String) - Filters used to affect the data returned from the custom report. Filters are 'column name = filter value' pairs, delimited by semi-colon ';' For example, Username=admin;PackageID=23; Filter combinations form a logical AND when using more than one.

Returns:

An array of Objecs representing the rows and fields from a custom report

Possible Exceptions:

INVALID OWNER ID
INVALID REPORT NAME

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetRenderedCustomReport xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
      <reportName>string</reportName>
      <filters>string</filters>
    </GetRenderedCustomReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRenderedCustomReportResponse xmlns="Logisense_EngageIP">
      <GetRenderedCustomReportResult>
        <Headers>
          <string>string</string>
          <string>string</string>
        </Headers>
        <Records>
          <ArrayOfAnyType>
            <anyType />
            <anyType />
          </ArrayOfAnyType>
          <ArrayOfAnyType>
            <anyType />
            <anyType />
          </ArrayOfAnyType>
        </Records>
      </GetRenderedCustomReportResult>
    </GetRenderedCustomReportResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.