Get Template Details API

Use this API to returns details for a template in the API user’s scope.

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

Permissions

The user must have the Security Assessment Questionnaire (SAQ) module enabled, User must have API ACCESS permission, Output includes templates within the API user's scope.

Input ParameterInput Parameter

The element id (Integer) is required, where id identifies a template of interest.

Sample - Get Details of TemplateSample - Get Details of Template

API Request

curl -u "USERNAME:PASSWORD" -X GET https://<qualysbaseurl>/qps/rest/1.0/get/saq/template/82969 

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/template.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <Template>
            <id>82969</id>
            <uuid>5d9e0a22-14ff-4961-b0f0-a663c3b7f2f3</uuid>
            <name>template-from-api-with-scoring</name>
            <description>template containing scoring fields created from the api</description>
            <familyId>75120987-737d-4157-9b3f-d0c2229d8c1d</familyId>
            <revision>1</revision>
            <isLibrary>false</isLibrary>
            <questionCnt>5</questionCnt>
            <state>DRAFT</state>
            <elements>
                <sections>
                    <list>
                        <Section>
                            <name>section 1</name>
                            <description>section 1 description</description>
                            <questions>
                                <list>
                                    <Question>
                                        <label>0</label>
                                        <text>Question 0</text>
                                        <type>booleanQuestion</type>
                                        <mode>BUTTON</mode>
                                        <criticality>CRITICAL</criticality>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                        <yesScoringLabel>HIGH</yesScoringLabel>
                                        <noScoringLabel>MEDIUM</noScoringLabel>
                                    </Question>
                                    <Question>
                                        <label>1</label>
                                        <text>QUESTION 1</text>
                                        <type>booleanQuestion</type>
                                        <mode>BUTTON</mode>
                                        <criticality>CRITICAL</criticality>
                                        <requireAttachment>false</requireAttachment>
                                        <requireComment>false</requireComment>
                                        <requireAsset>false</requireAsset>
                                        <yesScoringLabel>HIGH</yesScoringLabel>
                                        <noScoringLabel>MEDIUM</noScoringLabel>
                                    </Question>
                                </list>
                            </questions>
                        </Section>
                        <Section>
                            <name>section 2</name>
                            <description>section 2 description</description>
                            <questions>
                                <list>
                                    <Question>
                                        <label>3</label>
                                        <text>QUESTION 3</text>
                                        <type>multipleChoiceQuestion</type>
                                        <mode>MULTI_SELECT</mode>
                                        <criticality>INFO</criticality>
                                        <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>
                                </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>
</ServiceResponse> 

XSDXSD

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