Report Count

[GET]  [POST] /qps/rest/3.0/count/was/report

Returns the total number of reports in the user’s scope.

Permissions required User must have WAS module enabled. User account must have these permissions: Access Permission “API Access”. The output includes reports in the user's scope.

Input ParametersInput Parameters

These elements are optional and act as filters. When multiple elements are specified, parameters are combined using a logical AND. See Reference: Report for descriptions of these <Report> elements

Click here for available operators

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.

tags.id

Optional

integer

ID of the tag associated with the report.

tags.name

Optional

text

Name of the tag associated with the report.

creationDate

Optional

date

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

type

Optional

keyword

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

format

Optional

keyword

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

status

Optional

keyword

The status of the report: RUNNING, ERROR or COMPLETE.

Sample - Get count of reports in user's accountSample - Get count of reports in user's account

Return the number (count) of all reports in the user’s scope.

API request

curl -u "USERNAME:PASSWORD" <qualys_base_url>/qps/rest/3.0/count/was/report"    
    

XML response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/3.0/was/report.xsd"
    <ServiceResponse>
        <count>12</count>
        <responseCode>SUCCESS</responseCode>
    </ServiceResponse>      
    

Sample - Get count of reports with a criteriaSample - Get count of reports with a criteria

Return the number (count) reports with an ID that includes 1302 and 1303.

API request

      
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/3.0/count/was/report" < file.xml
Note: “file.xml” contains the request POST data.    

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="id" operator="IN">1302, 1303</Criteria>
    </filters>
</ServiceRequest>

XML response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/3.0/was/report.xsd"
    <ServiceResponse>
        <count>1</count>
        <responseCode>SUCCESS</responseCode>
    </ServiceResponse>    
    

XSD

<platform API server>/qps/xsd/3.0/was/report.xsd