Create New Template API

Use this API to create a new template. 

POST /qps/rest/1.0/create/saq/template/

Permissions

User must have the Security Assessment Questionnaire (SAQ) module enabled, User must have API ACCESS, Access SAQ module, Questionnaire Invite and Questionnaire Template Create permissions.

Input ParameterInput Parameter

See Reference: Template for descriptions of supported elements.

Sample - Create a TemplateSample - Create a Template

API Request

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

 

Request POST Data

<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
   <data>
      <Template>
         <name>template-using-api</name>
         <description>template using api</description>
         <elements>
            <sections>
               <list>
                  <Section>
                     <name>section 1</name>
                     <description>section 1 description </description>
                     <questions>
                        <list>
                           <Question>
                              <type>textQuestion</type>
                              <mode>SIDE_BY_SIDE</mode>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>text question</text>
                              <label>0</label>
                           </Question>
                           <Question>
                              <type>textQuestion</type>
                              <mode>SIDE_BY_SIDE</mode>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>formatted question</text>
                              <label>1</label>
                           </Question>
                           <Question>
                              <type>multipleChoiceQuestion</type>
                              <mode>COMPACT</mode>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>drop down question</text>
                              <label>2</label>
                              <answers>
                                 <list>
                                    <Answer>
                                       <title>a</title>
                                       <value>0</value>
                                       <scoringLabel>LOW</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                    <Answer>
                                       <title>b</title>
                                       <value>1</value>
                                       <scoringLabel>MEDIUM</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                    <Answer>
                                       <title>c</title>
                                       <value>2</value>
                                       <scoringLabel>HIGH</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                 </list>
                              </answers>
                           </Question>
                           <Question>
                              <type>booleanQuestion</type>
                              <mode>BUTTON</mode>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>boolean question</text>
                              <label>3</label>
                              <criticality>INFO</criticality>
                              <yesScoringLabel>MEDIUM</yesScoringLabel>
                              <noScoringLabel>LOW</noScoringLabel>
                           </Question>
                           <Question>
                              <type>multipleChoiceQuestion</type>
                              <mode>MULTI_SELECT</mode>
                              <criticality>INFO</criticality>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>multiselect question</text>
                              <label>4</label>
                              <answers>
                                 <list>
                                    <Answer>
                                       <title>1</title>
                                       <value>1</value>
                                       <scoringLabel>LOW</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                    <Answer>
                                       <title>2</title>
                                       <value>2</value>
                                       <scoringLabel>MEDIUM</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                    <Answer>
                                       <title>3</title>
                                       <value>3</value>
                                       <scoringLabel>HIGH</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                 </list>
                              </answers>
                           </Question>
                           <Question>
                              <type>multipleChoiceQuestion</type>
                              <mode>EXPANDED</mode>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>single select question</text>
                              <label>5</label>
                              <answers>
                                 <list>
                                    <Answer>
                                       <title>a</title>
                                       <value>0</value>
                                       <scoringLabel>LOW</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                    <Answer>
                                       <title>b</title>
                                       <value>1</value>
                                       <scoringLabel>MEDIUM</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                    <Answer>
                                       <title>c</title>
                                       <value>2</value>
                                       <scoringLabel>HIGH</scoringLabel>
                                       <requireAttachment>false</requireAttachment>
                                       <requireComment>false</requireComment>
                                       <requireAsset>false</requireAsset>
                                    </Answer>
                                 </list>
                              </answers>
                           </Question>
                           <Question>
                              <type>dateQuestion</type>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>date question</text>
                              <label>6</label>
                           </Question>
                           <Question>
                              <type>numericQuestion</type>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>numeric question</text>
                              <label>7</label>
                           </Question>
                        </list>
                     </questions>
                  </Section>
                  <Section>
                     <name>Section 2</name>
                     <description>Section 2description</description>
                     <questions>
                        <list>
                           <Question>
                              <type>numericQuestion</type>
                              <requireAttachment>false</requireAttachment>
                              <requireComment>false</requireComment>
                              <requireAsset>false</requireAsset>
                              <text>Section 2 numeric question</text>
                              <label>8</label>
                           </Question>
                        </list>
                     </questions>
                  </Section>
               </list>
            </sections>
         </elements>
         <scorings>
            <list>
               <Scoring>
                  <label>LOW</label>
                  <value>0</value>
               </Scoring>
               <Scoring>
                  <label>MEDIUM</label>
                  <value>50</value>
               </Scoring>
               <Scoring>
                  <label>HIGH</label>
                  <value>100</value>
               </Scoring>
            </list>
         </scorings>
      </Template>
   </data>
</ServiceRequest>

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://<qualysbaseurl>/qps/xsd/1.0/saq/template.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <Template>
            <id>145601</id>
            <uuid>6b822c40-00e4-4c70-a8c2-1a8f2b296a1c</uuid>
            <name>template-using-api</name>
            <description>template using api</description>
            <familyId>b5bfc411-6c3f-40a6-b005-66bc4741aadc</familyId>
            <revision>1</revision>
            <isLibrary>false</isLibrary>
            <questionCnt>9</questionCnt>
            <state>DRAFT</state>
            <elements>
                <sections>
                    <list>
                        <Section>
                            <name>section 1</name>
                            <description>section 1
description</description>
                            <sections/>
                            <questions>
                                <list>
                                    <Question>
                                        <label>0</label>
                                        <text>text question</text>
                                        <type>textQuestion</type>
                                        <mode>SIDE_BY_SIDE</mode>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                    <Question>
                                        <label>1</label>
                                        <text>formatted question</text>
                                        <type>textQuestion</type>
                                        <mode>SIDE_BY_SIDE</mode>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                    <Question>
                                        <label>2</label>
                                        <text>drop down question</text>
                                        <type>multipleChoiceQuestion</type>
                                        <mode>COMPACT</mode>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                        <answers>
                                            <list>
                                                <Answer>
                                                    <title>a</title>
                                                    <value>0</value>
                                                    <scoringLabel>LOW</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                                <Answer>
                                                    <title>b</title>
                                                    <value>1</value>
                                                    <scoringLabel>MEDIUM</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                                <Answer>
                                                    <title>c</title>
                                                    <value>2</value>
                                                    <scoringLabel>HIGH</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                            </list>
                                        </answers>
                                    </Question>
                                    <Question>
                                        <label>3</label>
                                        <text>boolean question</text>
                                        <type>booleanQuestion</type>
                                        <mode>BUTTON</mode>
                                        <criticality>INFO</criticality>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                        <yesScoringLabel>MEDIUM</yesScoringLabel>
                                        <noScoringLabel>LOW</noScoringLabel>
                                    </Question>
                                    <Question>
                                        <label>4</label>
                                        <text>multiselect question</text>
                                        <type>multipleChoiceQuestion</type>
                                        <mode>MULTI_SELECT</mode>
                                        <criticality>INFO</criticality>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                        <answers>
                                            <list>
                                                <Answer>
                                                    <title>1</title>
                                                    <value>1</value>
                                                    <scoringLabel>LOW</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                                <Answer>
                                                    <title>2</title>
                                                    <value>2</value>
                                                    <scoringLabel>MEDIUM</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                                <Answer>
                                                    <title>3</title>
                                                    <value>3</value>
                                                    <scoringLabel>HIGH</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                            </list>
                                        </answers>
                                    </Question>
                                    <Question>
                                        <label>5</label>
                                        <text>single select question</text>
                                        <type>multipleChoiceQuestion</type>
                                        <mode>EXPANDED</mode>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                        <answers>
                                            <list>
                                                <Answer>
                                                    <title>a</title>
                                                    <value>0</value>
                                                    <scoringLabel>LOW</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                                <Answer>
                                                    <title>b</title>
                                                    <value>1</value>
                                                    <scoringLabel>MEDIUM</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                                <Answer>
                                                    <title>c</title>
                                                    <value>2</value>
                                                    <scoringLabel>HIGH</scoringLabel>
                                                    <requireAttachment>false</requireAttachment>
                                                    <requireComment>false</requireComment>
                                                    <requireAsset>false</requireAsset>
                                                </Answer>
                                            </list>
                                        </answers>
                                    </Question>
                                    <Question>
                                        <label>6</label>
                                        <text>date question</text>
                                        <type>dateQuestion</type>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                    <Question>
                                        <label>7</label>
                                        <text>numeric question</text>
                                        <type>numericQuestion</type>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                </list>
                            </questions>
                        </Section>
                        <Section>
                            <name>Section 2</name>
                            <description>Section 2description</description>
                            <sections/>
                            <questions>
                                <list>
                                    <Question>
                                        <label>8</label>
                                        <text>Section 2 numeric question</text>
                                        <type>numericQuestion</type>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                </list>
                            </questions>
                        </Section>
                    </list>
                </sections>
                <questions/>
            </elements>
            <scorings>
                <list>
                    <Scoring>
                        <label>LOW</label>
                        <value>0</value>
                    </Scoring>
                    <Scoring>
                        <label>MEDIUM</label>
                        <value>50</value>
                    </Scoring>
                    <Scoring>
                        <label>HIGH</label>
                        <value>100</value>
                    </Scoring>
                </list>
            </scorings>
        </Template>
    </data>
</ServiceResponse> 

Sample - Create Multiple TemplatesSample - Create Multiple Templates

API Request

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

Request POST Data

 <?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
  <data>
     <Template>
       <name> template-api-1-boolean-question</name>
       <description>template-api template-api-1-boolean-question</description>
       <elements>
            <sections>
                <list>
                    <Section>
                        <name>section 1</name>
                        <description>description section 1</description>
                        <questions>
                            <list>
                            <Question>
                                <label>boolean question label</label>
                                <text>boolean question text</text>
                                <type>booleanQuestion</type>
                                <answers>
                                    <list>
                                        <Answer>
                                            <title>no</title>
                                            <value>0</value>
                                        </Answer>
                                        <Answer>
                                            <title>yes</title>
                                            <value>1</value>
                                        </Answer>
                                    </list>
                                </answers>
                            </Question>
                            </list>
                        </questions>
                    </Section>
                    </list>
            </sections>
       </elements>
     </Template>
     <Template>
       <name> template-api-1-boolean-question 2</name>
       <description>template-api template-api-1-boolean-question 2</description>
       <elements>
            <sections>
                <list>
                    <Section>
                        <name>section 1</name>
                        <description>description section 1</description>
                        <questions>
                            <list>
                            <Question>
                                <label>boolean question label 2</label>
                                <text>boolean question text 2</text>
                                <type>booleanQuestion</type>
                                <answers>
                                    <list>
                                        <Answer>
                                            <title>no</title>
                                            <value>0</value>
                                        </Answer>
                                        <Answer>
                                            <title>yes</title>
                                            <value>1</value>
                                        </Answer>
                                    </list>
                                </answers>
                            </Question>
                            </list>
                        </questions>
                    </Section>
                    </list>
            </sections>
       </elements>
     </Template>
  </data>


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/template.xsd">
<responseCode>SUCCESS</responseCode>
    <count>2</count>
    <data>
        <Template>
            <id>82971</id>
            <uuid>a25a405c-2ef5-40ab-b747-518d37057853</uuid>
            <name> template-api-1-boolean-question</name>
            <description>template-api template-api-1-boolean-question</description>
            <familyId>948192e8-0fbd-4fca-bc50-5412f6ee91ff</familyId>
            <revision>1</revision>
            <isLibrary>false</isLibrary>
            <questionCnt>0</questionCnt>
            <state>DRAFT</state>
            <elements>
                <sections>
                    <list>
                        <Section>
                            <name>section 1</name>
                            <description>description section 1</description>
                            <sections/>
                            <questions>
                                <list>
                                    <Question>
                                        <label>boolean question label</label>
                                        <text>boolean question text</text>
                                        <type>booleanQuestion</type>
                                        <mode>BUTTON</mode>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                </list>
                            </questions>
                        </Section>
                    </list>
                </sections>
                <questions/>
            </elements>
        </Template>
        <Template>
            <id>82972</id>
            <uuid>1bb7ff3f-fba8-4825-8281-fff9cb0be016</uuid>
            <name> template-api-1-boolean-question 2</name>
            <description>template-api template-api-1-boolean-question 2</description>
            <familyId>729c630e-2919-488a-b974-41089df8ea7b</familyId>
            <revision>1</revision>
            <isLibrary>false</isLibrary>
            <questionCnt>0</questionCnt>
            <state>DRAFT</state>
            <elements>
                <sections>
                    <list>
                        <Section>
                            <name>section 1</name>
                            <description>description section 1</description>
                            <sections/>
                            <questions>
                                <list>
                                    <Question>
                                        <label>boolean question label 2</label>
                                        <text>boolean question text 2</text>
                                        <type>booleanQuestion</type>
                                        <mode>BUTTON</mode>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                    </Question>
                                </list>
                            </questions>
                        </Section>
                    </list>
                </sections>
                <questions/>
            </elements>
        </Template>
    </data>
</ServiceResponse> 

XSDXSD

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