Get details of Report Template

[GET] /qps/rest/3.0/get/was/reporttemplate/<id>

View details for a report template which is in the user’s scope. See “Search Report Template” to find a record ID to use as input.

Permissions required - User must have WAS module enabled. User account must have these permissions: Access Permission “API Access”.

Input ParametersInput Parameters

The element “id” (integer) is required, where “id” identifies the report.

Click here for available operators

Sample - Get details of the report templateSample - Get details of the report template

Let us get details of a report template.

API request

curl -u "USERNAME:PASSWORD" "<qualys_base_url>/qps/rest/3.0/get/was/reporttemplate/876048"      
    

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/reporttemplate.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
    <ReportTemplate>
        <id>876048</id>
        <name>
        <![CDATA[Web Application Report]]>
        </name>
        <description>
        <![CDATA[Each targeted web application is listed with the total number of detected vulnerabilities and sensitive content.]]>
        </description>
        <owner>
        <id>23220145</id>
        <username>john_doe</username>
        <firstName>
            <![CDATA[John]]>
        </firstName>
        <lastName>
            <![CDATA[Doe]]>
        </lastName>
        </owner>
        <type>WAS_WEBAPP_REPORT</type>
        <creationDate>2017-04-11T09:29:23Z</creationDate>
        <tags>
        <count>0</count>
        </tags>
        <config>
        <webAppReportTemplate>
            <display>
            <contents>
                <WebAppReportContent>DESCRIPTION</WebAppReportContent>
                <WebAppReportContent>SUMMARY</WebAppReportContent>
                <WebAppReportContent>GRAPHS</WebAppReportContent>
                <WebAppReportContent>RESULTS</WebAppReportContent>
                <WebAppReportContent>INDIVIDUAL_RECORDS</WebAppReportContent>
                <WebAppReportContent>RECORD_DETAILS</WebAppReportContent>
                <WebAppReportContent>APPENDIX</WebAppReportContent>
            </contents>
            <graphs>
                <WebAppReportGraph>VULNERABILITIES_BY_SEVERITY</WebAppReportGraph>
                <WebAppReportGraph>VULNERABILITIES_BY_STATUS</WebAppReportGraph>
                <WebAppReportGraph>VULNERABILITIES_BY_GROUP</WebAppReportGraph>
                <WebAppReportGraph>VULNERABILITIES_BY_OWASP</WebAppReportGraph>
            </graphs>
            <groups>
                <WebAppReportGroup>WEBAPP</WebAppReportGroup>
                <WebAppReportGroup>CATEGORY</WebAppReportGroup>
                <WebAppReportGroup>GROUP</WebAppReportGroup>
                <WebAppReportGroup>QID</WebAppReportGroup>
            </groups>
            <options>
                <rawLevels>true</rawLevels>
            </options>
            </display>
            <filters>
            <includedSearchLists/>
            <excludedSearchLists/>
            <url>
                <![CDATA[null]]>
            </url>
            <status>
                <WebAppFindingStatus>NEW</WebAppFindingStatus>
                <WebAppFindingStatus>ACTIVE</WebAppFindingStatus>
                <WebAppFindingStatus>REOPENED</WebAppFindingStatus>
            </status>
            <remediation>
                <showPatched>SHOW_BOTH</showPatched>
                <showIgnored>SHOW_NONE</showIgnored>
                <ignoredReasons>
                <IgnoredReason>NOT_APPLICABLE</IgnoredReason>
                <IgnoredReason>FALSE_POSITIVE</IgnoredReason>
                <IgnoredReason>RISK_ACCEPTED</IgnoredReason>
                </ignoredReasons>
            </remediation>
            </filters>
        </webAppReportTemplate>
        </config>
    </ReportTemplate>
    </data>
</ServiceResponse>      
    

XSD

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