Create a New Campaign API

Use this API to create a new campaign.

POST/qps/rest/1.0/create/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 Create permissions.

Input ParameterInput Parameter

See Reference: Campaign for descriptions of supported elements.

Sample - Create a CampaignSample - Create a Campaign

API Request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-
"https://<qualysbaseurl>/qps/rest/1.0/create/saq/questionnairecampaign/" <file.xml
Note: "file.xml" contains the request POST data.

Request POST Data

 <?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
 <data>
    <QuestionnaireCampaign>
        <name>Test API demo 1</name>
        <template>
            <id>122601</id>
        </template>
        <workflowType>REVIEWABLE</workflowType>
        <dueDate>2019-10-23T17:08:00Z</dueDate>
        <reviewer>
            <id>352088</id>
        </reviewer>
        <campaignNotification>
            <reminderNotification>
                <enabled>true</enabled>
                <interval>2</interval>
                <noOfDays>2</noOfDays>
            </reminderNotification>
            <overdueNotification>
                <enabled>false</enabled>
            </overdueNotification>
        </campaignNotification>
    </QuestionnaireCampaign>
 </data>
</ServiceRequest>

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>
            <id>120802</id>
            <name>Test API demo 1</name>
            <workflowType>REVIEWABLE</workflowType>
            <status>INACTIVE</status>
            <dueDate>2019-10-28T17:08:00Z</dueDate>
            <created>2019-10-23T10:24:16Z</created>
            <updated>2019-10-23T10:24:16Z</updated>
            <template>
                <id>122601</id>
            </template>
            <user>
                <id>337590</id>
            </user>
            <reviewer>
                <id>352088</id>
            </reviewer>
            <campaignNotification>
                <reminderNotification>
                    <enabled>true</enabled>
                    <interval>2</interval>
                    <noOfDays>2</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