Reference: Report

The <Report> element includes sub-elements used to define a web application report. A reference to these elements is provided below. An asterisk * indicates a complex element.

Parameter

Mandatory

/Optional

Data Type

Description

id

Optional

integer

The report ID. This element is assigned by the service and is required for a certain type of request (details, status, update, delete, send or download).

name

Optional

text

A report name (maximum 256 characters). Applies to all reports.

Note: Generating a report without template will allow you to assign a name to the report. If you use template during report generation, the name you provide in the request is ignored and the template name is assigned to the report.

description

Optional

text

A description of the report.

owner*

Optional

 

This element is assigned by the service and may be specified for an update request only.

Example:

<owner>

  <id>123056</id>

  <username>username</username>

  <firstName><![CDATA[Johns]]></firstName>

  <lastName><![CDATA[Smith]]></lastName>

</owner>

type

Optional

text

The report type, one of: WAS_SCAN_REPORT, WAS_WEBAPP_REPORT, WAS_SCORECARD_REPORT, WAS_CATALOG_REPORT, DATALIST_REPORT

format

Optional

text

The format of the report, one of: HTML_ZIPPED, HTML_BASE64, PDF, PDF_ENCRYPTED, POWERPOINT, CSV, CSV_V2, XML, WORD

tags*

Optional

 

This element identifies the tags associated with the report.

Example:

<tags>

  <count>2</count>

  <list>

    <Tag>

      <id>99509</id>

      <name><![CDATA[Tag 1]]></name>

   </Tag>

   <Tag>

     <id>99511</id>

     <name><![CDATA[Tag 2]]></name>

    </Tag>

  </list>

</tags>

password

Optional

text

The password for a PDF encrypted report.

distributionList*

Optional

 

This element specifies the email addresses for distribution of the report.

Example:

<distributionList>

  <count>2</count>

   <list>

<EmailAddress><![CDATA[1@abc.com]]></EmailAddress>

<EmailAddress><![CDATA[2@abc.com]]></EmailAddress>

  </list>

</distributionList>

config*

...

Optional

 

The configuration options for report creation.

Example:

<config>

  <webAppReport>

     <target>

       <tags>

         <Tag>

           <id>102609</id>

         </Tag>

       </tags>

       <webapps>

         <WebApp>

            <id>324538</id>

          </WebApp>

        </webapps>

      </target>

status

Optional

keyword

The status of the report: RUNNING, ERROR or COMPLETE

creationDate

Optional date

The date when the report was created in UTC date/time format (YYYY-MM-DDTHH:MM:SSZ).

lastDownloadDate

Optional date

The date when the report was last downloaded in UTC date/time format (YYYY-MM-DDTHH:MM:SSZ).

downloadCount

Optional integer

The number of times the report has been downloaded.