Search Library Templates API

Use this API to search library templates in the API user’s scope.

POST  /qps/rest/1.0/search/saq/librarytemplate/

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 following input elements are optional and act as filters. When multiple elements are specified, parameters are combined using a logical AND.

Parameter Mandatory/Optional Data Type Description Allowed Operators
id Optional Integer ID of the template. EQUALS, IN
uuid Optional Integer Unique ID of the template. EQUALS
name Optional Text Name of the template. CONTAINS, EQUALS
description Optional Text Description of the template. CONTAINS, EQUALS
category Optional Text Category of the template. CONTAINS, EQUALS
familyId Optional Integer  Family identifier of the template. EQUALS
revision Optional Integer Version of the template. EQUALS, IN
isLibrary Optional Boolean True if the template is created from a library template. EQUALS
questionCnt Optional Integer Count of questions in a template. EQUALS, IN
state Optional String State of the template (Published, Draft) EQUALS, IN

Sample - Search Library TemplatesSample - Search Library Templates

API Request

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

 

Request POST Data

<ServiceRequest>
      <filters>
      <Criteria field="name" operator="CONTAINS">Vendor Risk Assessment</Criteria> </filters>
</ServiceRequest> 

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/librarytemplate.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <hasMoreRecords>false</hasMoreRecords>
    <data>
        <LibraryTemplate>
            <id>10030</id>
            <uuid>9fc12d51-0dbb-416c-933c-9762831f8af7</uuid>
            <name>Vendor Risk Assessment</name>
            <description>Vendor Risk Assessment Questionnaire template provides a standard approach to all High Risk Vendors</description>
            <familyId>f431d2ba-462c-4d14-a8de-5ee2c4c770ce</familyId>
            <revision>1</revision>
            <isLibrary>true</isLibrary>
            <questionCnt>288</questionCnt>
            <state>RETIRED</state>
        </LibraryTemplate>
    </data>
</ServiceResponse> 

XSDXSD

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