View Campaign Summary API

Use this API to view the details of a campaign.

POST/qps/rest/1.0/summary/saq/questionnairecampaign/<id>

Permissions

The user must have the Security Assessment Questionnaire (SAQ) module enabled; the user must have API ACCESS, Access SAQ module, and Questionnaire Campaign View permissions. The campaign must be within the API user's scope.

Input ParameterInput Parameter

The id (Long) and comments (Comments for canceling the campaign) elements are required.

Sample - View Campaign SummarySample - View Campaign Summary

API Request

 curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST"--data-binary @-
"https:// <qualysbaseurl>/qps/rest/1.0/summary/saq/questionnairecampaign/684001"

 

Response

 <?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http:// <qualysbaseurl>/qps/xsd/1.0/saq/questionnairecampaign.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <QuestionnaireCampaign>
            <name>Campaign_RevBP</name>
            <workflowType>REVIEWABLE</workflowType>
            <template>
                <name>ASQTe</name>
            </template>
            <reviewer>
                <id>71077391</id>
                <userName>reviewer.r.39b9xw@qualys</userName>
            </reviewer>
            <summary>
                <count>2</count>
                <list>
                    <QuestionnaireSummary>
                        <state>Closed</state>
                        <value>1</value>
                    </QuestionnaireSummary>
                    <QuestionnaireSummary>
                        <state>In Progress</state>
                        <value>1</value>
                    </QuestionnaireSummary>
                </list>
            </summary>
        </QuestionnaireCampaign>
    </data>
</ServiceResponse>

XSDXSD

<platform API server>/qps/xsd/1.0/saq/questionnairecampaign.xsd