Update a Campaign API

Use this API to update a campaign.

POST /qps/rest/1.0/update/saq/questionnairecampaign/

Permissions

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

Input ParameterInput Parameter

The id element is required, other elements are optional. See Reference: Campaign for descriptions of supported elements.

Sample - Update a CampaignSample - Update a Campaign

API Request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST"--data-binary @-
"https://<qualysbaseurl>/qps/rest/1.0/update/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>
        <id>120802</id>
        <workflowType>FULL</workflowType>
        <approver>
                <id>352088</id>
        </approver>
        <reviewer>
            <id>352088</id>
        </reviewer>
        <recipients>
            <add>
                <User>
                    <id>339590</id>
                    <assigned>New </assigned>
                </User>
                <User>
                    <id>339591</id>
                    <assigned>New </assigned>
                </User>
            </add>
        </recipients>
        <campaignNotification>
            <overdueNotification>
                <enabled>true</enabled>
                <interval>1</interval>
                <noOfDays>5</noOfDays>
            </overdueNotification>
            <dueDateNotification>
                <enabled>false</enabled>
            </dueDateNotification>
        </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://qualysapi.qualys.com/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>FULL</workflowType>
            <status>INACTIVE</status>
            <dueDate>2019-10-23T17:08:00Z</dueDate>
            <created>2019-10-21T10:24:16Z</created>
            <updated>2019-10-21T10:26:56Z</updated>
            <template>
                <id>122601</id>
            </template>
            <user>
                <id>337590</id>
            </user>
            <reviewer>
                <id>352088</id>
            </reviewer>
            <approver>
                <id>352088</id>
            </approver>
            <campaignNotification>
                <reminderNotification>
                    <enabled>true</enabled>
                    <interval>2</interval>
                    <noOfDays>2</noOfDays>
                </reminderNotification>
                <overdueNotification>
                    <enabled>true</enabled>
                    <interval>1</interval>
                    <noOfDays>5</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