/api/space/config-template-management/config-templates/{template-id}/configuration

The following operations are supported on this resource:

  • GET - Return a template configuration in CLI format
  • GET - Return a template configuration in XML format
  • GET - Return a template configuration in CLI or XML format
  • POST - Set configuration for template
  • POST - Save Quick Template Config XML
GET /config-templates/{template-id}/configurationVersion 2

This API returns a template configuration in XML or JSON format.

Sample Usage

GET /config-templates/{template-id}/configuration


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    templateidStringPathThe ID of the configuration template. Y
  • Sample Output XML:
    <configuration-cli uri="/api/space/config-template-management/config-templates/{template-id}/configuration">
         <cli>String</cli>
    </configuration-cli>

  • Sample Output JSON:
    {
       "configuration-cli" : {
         "@uri" :
         "/api/space/config-template-management/config-templates/{template-id}/configuration"
         ,
         "cli" : "String"
       }
    }

  • GET /config-templates/{template-id}/configurationVersion 2

    This API returns a template configuration in XML or JSON format.

    Sample Usage

    GET /config-templates/{template-id}/configuration


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      templateidStringPathThe ID of the configuration template. Y
  • Sample Output XML:
    <configuration-xml uri="/api/space/config-template-management/config-templates/{template-id}/configuration">
         <xml><![CDATA[String]]></xml>
    </configuration-xml>

  • Sample Output JSON:
    {
       "configuration-xml" : {
         "@uri" :
         "/api/space/config-template-management/config-templates/{template-id}/configuration"
         ,
         "xml" : "String"
       }
    }

  • GET /config-templates/{template-id}/configurationVersion 2

    This API returns a configuration template in XML or JSON format.

    Sample Usage

    GET /config-templates/{template-id}/configuration


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      templateidStringPathThe ID of the configuration template. Y
  • Sample Output XML:
    <configuration-all uri="/api/space/config-template-management/config-templates/{template-id}/configuration">
         <cli>String</cli>
         <xml><![CDATA[String]]></xml>
    </configuration-all>

  • Sample Output JSON:
    {
       "configuration-all" : {
         "@uri" :
         "/api/space/config-template-management/config-templates/{template-id}/configuration"
         ,
         "cli" : "String" ,
         "xml" : "String"
       }
    }

  • POST /config-templates/{template-id}/configurationVersion 2

    This API sets a template configuration. It takes the JSON format only.

    Sample Usage

    POST /config-templates/{template-id}/configuration


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      templateidStringPathTemplate ID Y
  • Sample Input XML:
    <configuration-cli-request>
         <clis>String</clis>
    </configuration-cli-request>

  • Sample Output XML:
    <configuration-update-result uri="/api/space/config-template-management/config-templates/{template-id}/configuration">
         <err-message>String</err-message>
         <errors>
               <validation-error>
                   <err-reason>String</err-reason>
                   <line-number>Integer</line-number>
               </validation-error>
         </errors>
         <status>String</status>
         <variable-existing>Boolean</variable-existing>
    </configuration-update-result>

  • Sample Input JSON:
    {
       "configuration-cli-request" : {
         "clis" : "String"
       }
    }

  • Sample Output JSON:
    {
       "configuration-update-result" : {
         "@uri" :
         "/api/space/config-template-management/config-templates/{template-id}/configuration"
         ,
         "err-message" : "String" ,
         "errors" : {
           "validation-error" : {
             "err-reason" : "String" ,
             "line-number" : "Integer"
           }
         } ,
         "status" : "String" ,
         "variable-existing" : "Boolean"
       }
    }

  • POST /config-templates/{template-id}/configurationVersion 2

    Save Quick Template Config XML.

    Sample Usage

    POST /config-templates/{template-id}/configuration


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      templateidStringPathTemplate ID Y
  • Sample Input XML:
    <configuration-xml-request>
         <xml><![CDATA[String]]></xml>
    </configuration-xml-request>

  • Sample Output XML:
    <configuration-update-result uri="/api/space/config-template-management/config-templates/{template-id}/configuration">
         <err-message>String</err-message>
         <errors>
               <validation-error>
                   <err-reason>String</err-reason>
                   <line-number>Integer</line-number>
               </validation-error>
         </errors>
         <status>String</status>
         <variable-existing>Boolean</variable-existing>
    </configuration-update-result>

  • Sample Input JSON:
    {
       "configuration-xml-request" : {
         "xml" : "String"
       }
    }

  • Sample Output JSON:
    {
       "configuration-update-result" : {
         "@uri" :
         "/api/space/config-template-management/config-templates/{template-id}/configuration"
         ,
         "err-message" : "String" ,
         "errors" : {
           "validation-error" : {
             "err-reason" : "String" ,
             "line-number" : "Integer"
           }
         } ,
         "status" : "String" ,
         "variable-existing" : "Boolean"
       }
    }

  • Access Control

    The following capabilities are required to access this API: CreateTemplate