Get Campaign Details API

Returns details for a campaign in the API user’s scope.

GET /qps/rest/1.0/get/saq/questionnairecampaign/<id>

Permissions

The users must have the Security Assessment Questionnaire (SAQ) module enabled, the User must have API ACCESS permission, and the Output include campaigns within the API user's scope. The campaign must be within the API user's scope.

Input ParameterInput Parameter

The element “id” (Integer) is required, where “id” identifies a campaign of interest.

Sample - Get Details of CampaignSample - Get Details of Campaign

API Request

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

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>640002</id>
            <name>Test-Campaign-KT</name>
            <workflowType>FULL</workflowType>
            <status>COMPLETE</status>
            <created>2019-10-23T05:47:16Z</created>
            <updated>2019-10-24T05:47:50Z</updated>
            <launchDate>2019-10-23T05:47:50Z</launchDate>
            <template>
                <id>722010</id>
                <name>Test-Template-KT</name>
                <questionCnt>19</questionCnt>
            </template>
            <user>
                <id>70596886</id>
                <uuid>3d124658-8f4f-771d-806d-1e18a04a1acf</uuid>
                <firstName>john</firstName>
                <lastName>doe</lastName>
                <emailAddress>user@email.com</emailAddress>
                <userName>user</userName>
                <title>QA</title>
                <tags>
                    <Tag>
                        <id>101271291</id>
                        <name>Unassigned Business Unit</name>
                    </Tag>
                </tags>
            </user>
            <reviewer>
                <id>71077391</id>
                <uuid>831b7266-08f5-4a10-afdd-ab9453075355</uuid>
                <firstName>api-user</firstName>
                <lastName>api-user</lastName>
                <company>afko</company>
                <emailAddress>user@email.com</emailAddress>
                <userName>user</userName>
                <title>reviewer</title>
            </reviewer>
            <approver>
                <id>89375990</id>
                <uuid>76fcec21-f674-4e17-a868-801f7a92c35c</uuid>
                <firstName>john</firstName>
                <lastName>doe</lastName>
                <company>afko</company>
                <emailAddress>user@email.com</emailAddress>
                <userName>user</userName>
            </approver>
            <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