Launch Campaign API

Use this API to launch a new campaign. You can launch campaigns that are inactive.

POST /qps/rest/1.0/launch/saq/questionnairecampaign/

Permissions

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

Input ParameterInput Parameter

The id (Long) element is required.

Sample - Launch a CampaignSample - Launch a Campaign

API Request

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

Post Data Request

<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
 <data>
    <QuestionnaireCampaign>
        <id>1111001</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>1111001</id>
            <name>TestCampaign4/3</name>
            <workflowType>SIMPLE</workflowType>
            <status>ACTIVE</status>
            <created>2024-04-03T08:58:57Z</created>
            <updated>2024-04-03T08:59:43Z</updated>
            <launchDate>2024-04-03T08:59:43Z</launchDate>
            <template>
                <id>1286001</id>
                <name>NCA Cloud Cybersecurity Controls CCC-1:2020 for Cloud Service Tenants (CSTs), Kingdom of Saudi Arabia</name>
                <questionCnt>44</questionCnt>
            </template>
            <user>
                <id>817087957</id>
                <uuid>af2d6d86-7feb-61dc-8025-939e0189403c</uuid>
                <firstName>AGMS -PCUI+PCRS: PC +SCA+SAQ</firstName>
                <lastName>Account</lastName>
                <emailAddress>nehsharma@qualys.com</emailAddress>
                <userName>quays_ca7</userName>
                <title>QA</title>
                <tags>
                    <Tag>
                        <id>26998628</id>
                        <name>Unassigned Business Unit</name>
                    </Tag>
                </tags>
            </user>
            <campaignNotification>
                <reminderNotification>
                    <enabled>false</enabled>
                    <interval>1</interval>
                    <noOfDays>1</noOfDays>
                </reminderNotification>
                <overdueNotification>
                    <enabled>false</enabled>
                    <interval>1</interval>
                    <noOfDays>1</noOfDays>
                </overdueNotification>
                <dueDateNotification>
                    <enabled>false</enabled>
                    <interval>1</interval>
                    <noOfDays>1</noOfDays>
                </dueDateNotification>
            </campaignNotification>
        </QuestionnaireCampaign>
    </data>
</ServiceResponse>

XSDXSD

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