Get Campaign Status API

Use this API to get status of a campaign.

GET qps/rest/1.0/status/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 id (Long) element is required.

Sample - Get Status of a CampaignSample - Get Status of a Campaign

API Request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "GET" --data-binary @-
"https:// <qualysbaseurl>/qps/rest/1.0/status/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>926001</id>
            <name>Demo-campaign-api-1</name>
            <status>ACTIVE</status>
        </QuestionnaireCampaign>
    </data>
</ServiceResponse>

XSDXSD

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