Complete Campaign API

Use this API to mark a campaign as complete. Only active campaigns can be marked complete.

POST/qps/rest/1.0/complete/saq/questionnairecampaign/

Permissions

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

Input ParameterInput Parameter

The id (Long) element is required.

Sample - Complete a CampaignSample - Complete a Campaign

API Request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-
"https://<qualysbaseurl>/qps/rest/1.0/complete/saq/questionnairecampaign/684001"
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation=<qualysbaseurl>/qps/xsd/1.0/saq/questionnairecampaign.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <QuestionnaireCampaign>
            <id>684001</id>
            <name>Test10_vinod</name>
            <status>COMPLETE</status>
        </QuestionnaireCampaign>
    </data>
</ServiceResponse>

Post Data Request


<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
    <data>
      <QuestionnaireCampaign>
        <comments>demo api complte </comments>
        <id>1110401</id>
      </QuestionnaireCampaign>
    </data>
</ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://qualysapi.p01.eng.sjc01.qualys.com/qps/xsd/1.0/saq/questionnairecampaign.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <QuestionnaireCampaign>
            <id>1110401</id>
            <name>NewCampaign4/2/2024</name>
            <status>COMPLETE</status>
        </QuestionnaireCampaign>
    </data>
</ServiceResponse>

XSDXSD

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