REST Resources

/api/space/config-template-management/config-templates

The following operations are supported on this resource:

  • GET - Gets all configuration templates
  • POST - Creates a configuration template from a configuration template definition
  • PATCH - Patche the configuration template collection
GET /config-templatesVersion 1

This API gets all configuration templates.

Sample Usage

GET /config-templates


  • Sample Output XML:
    <config-templates total="Integer" uri="/api/space/config-template-management/config-templates">
         <config-template
               href="/api/space/config-template-management/config-templates/{id}" uri="/api/space/config-template-management/config-templates/{id}">
               <id>Integer</id>
               <name>String</name>
               <os-version-field>String</os-version-field>
               <description>String</description>
               <config-type>CONFIG_TEMPLATE</config-type>
               <state>String</state>
               <os-version>String</os-version>
               <current-version>Integer</current-version>
               <device-family>String</device-family>
               <last-updated-by>String</last-updated-by>
               <last-update-time-string>String</last-update-time-string>
               <domain-name>String</domain-name>
               <domain-id>Integer</domain-id>
         </config-template>
    </config-templates>

  • Sample Output JSON:
    {
       "config-templates" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/config-template-management/config-templates" ,
         "config-template" : {
           "@href" : "/api/space/config-template-management/config-templates/{id}" ,
           "@uri" : "/api/space/config-template-management/config-templates/{id}" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "os-version-field" : "String" ,
           "description" : "String" ,
           "config-type" : "CONFIG_TEMPLATE" ,
           "state" : "String" ,
           "os-version" : "String" ,
           "current-version" : "Integer" ,
           "device-family" : "String" ,
           "last-updated-by" : "String" ,
           "last-update-time-string" : "String" ,
           "domain-name" : "String" ,
           "domain-id" : "Integer"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: ManageTemplates

    POST /config-templatesVersion 1

    This API creates a new configuration template from a configuration template definition. This API creates a draft first, and then commits it. The configuration template should include the device's name, a description, the device family, and the OS version.

    Sample Usage

    POST /config-templates


  • Sample Input XML:
    <config-template-no-definition>
         <domain-id>Integer</domain-id>
         <description>String</description>
         <name>String</name>
         <domain-name>String</domain-name>
         <device-family>String</device-family>
         <os-version>String</os-version>
    </config-template-no-definition>

  • Sample Output XML:
    <config-template-no-definition
         href="/api/space/config-template-management/config-templates/{id}" uri="/api/space/config-template-management/config-templates">
         <last-update-time>Long</last-update-time>
         <domain-id>Integer</domain-id>
         <description>String</description>
         <last-update-time-string>String</last-update-time-string>
         <id>Integer</id>
         <state>String</state>
         <name>String</name>
         <current-version>Integer</current-version>
         <last-updated-by>String</last-updated-by>
         <domain-name>String</domain-name>
         <device-family>String</device-family>
         <os-version>String</os-version>
         <config-type>CONFIG_TEMPLATE</config-type>
    </config-template-no-definition>

  • Sample Input JSON:
    {
       "config-template-no-definition" : {
         "domain-id" : "Integer" ,
         "description" : "String" ,
         "name" : "String" ,
         "domain-name" : "String" ,
         "device-family" : "String" ,
         "os-version" : "String"
       }
    }

  • Sample Output JSON:
    {
       "config-template-no-definition" : {
         "@href" : "/api/space/config-template-management/config-templates/{id}" ,
         "@uri" : "/api/space/config-template-management/config-templates" ,
         "last-update-time" : "Long" ,
         "domain-id" : "Integer" ,
         "description" : "String" ,
         "last-update-time-string" : "String" ,
         "id" : "Integer" ,
         "state" : "String" ,
         "name" : "String" ,
         "current-version" : "Integer" ,
         "last-updated-by" : "String" ,
         "domain-name" : "String" ,
         "device-family" : "String" ,
         "os-version" : "String" ,
         "config-type" : "CONFIG_TEMPLATE"
       }
    }

    • Access Control

    The following capabilities are required to access this API: AddConfigurationFilterCap

    PATCH /config-templatesVersion 1

    This API patches the configuration template collection. Use this API to make bulk additions and deletions of multiple templates.

    Sample Usage

    PATCH /config-templates


  • Sample Patch XML:
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <diff>
       <!--What you see below are just samples of patch operations that may be
         performed on this DTO. -->
       <!--For more information about patch document format please look at & http://http://www.rfc-editor.org/rfc/rfc5261.txt -->
       <add sel="config-templates">
                                                                                               
         <config-template>
           <name>String</name>
           <description>String</description>
           <state>String</state>
           <os-version>String</os-version>
           <current-version>Integer</current-version>
           <device-family>String</device-family>
           <last-updated-by>String</last-updated-by>
           <last-update-time>String</last-update-time>
         </config-template>
                                                                                               
       </add>

                                                                                                <!-- or -->

       <remove
         sel="config-templates/config-template[@some attribute='some value']" />

       <!-- or using element selection -->
       <remove sel="config-templates/config-template[some element='some value']" />
                                                                                             
    </diff>

    • Access Control

    The following capabilities are required to access this API: AddDeployedDevices