Cancel Campaign API

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

POST/qps/rest/1.0/cancel/saq/questionnairecampaign/

Permissions

The user must have the Security Assessment Questionnaire (SAQ) module enabled and have API ACCESS, Access SAQ module, and Questionnaire Campaign Cancel 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 - Cancel a CampaignSample - Cancel a Campaign

API Request

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

POST Data Request

<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
     <data>
      <QuestionnaireCampaign>
        <comments>demo api cancel </comments>
        <id>1110201</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>1110201</id>
            <name>TestCampaign3Stage62762</name>
            <status>CANCELED</status>
        </QuestionnaireCampaign>
    </data>
</ServiceResponse>

XSDXSD

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