Configuration Template Manager API

REST Resources

/api/space/config-template-management/config-template-definitions/{id}

The following operation is supported on this resource:

GET - Get a configuration template definition

GET /config-template-definitions/{id}

Version 1

This API gets a single configuration template definition.

Sample Usage

GET /config-template-definitions/{id}

Parameters:

Name Type URI Type Description Required

id Integer Path The ID of the configuration template definition to retrieve. Y

Accept Headers:
application/vnd.net.juniper.space.config-template-management.config-template-definition+xml;version=1
application/vnd.net.juniper.space.config-template-management.config-template-definition+json;version=1

XML
JSON

Sample Output XML:

<config-template-definition

         href="/api/space/config-template-management/config-template-definitions/{id}" uri="/api/space/config-template-management/config-template-definitions/{id}">

         <id>Integer</id>

         <name>String</name>

         <description>String</description>

         <versions>

              <version>Integer</version>

         </versions>

         <state>String</state>

         <published>Boolean</published>

         <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-templates uri="/api/space/config-template-management/config-template-definitions/{id}/config-templates">

              <config-template

                   href="/api/space/config-template-management/config-templates/{id}" uri="/api/space/config-template-management/config-template-definitions/{id}/config-templates/{id}">

                   <id>Integer</id>

                   <name>String</name>

              </config-template>

         </config-templates>

         <domain-name>String</domain-name>

         <domain-id>Integer</domain-id>

         <domain href="/api/space/domain-management/domains/{domainId}"/>

         <configuration href="/api/space/config-template-management/config-template-definitions/{id}/configuration"/>

 </config-template-definition>

Sample Output JSON:

{

      "config-template-definition" : {

        "@href" : "/api/space/config-template-management/config-template-definitions/{id}" ,

        "@uri" :"/api/space/config-template-management/config-template-definitions/{id}" ,

        "id" : "Integer" ,

        "name" : "String" ,

        "description" : "String" ,

        "versions" : {

          "version" : "Integer"

        } ,

        "state" : "String" ,

        "published" : "Boolean" ,

        "os-version" : "String" ,

        "current-version" : "Integer" ,

        "device-family" : "String" ,

        "last-updated-by" : "String" ,

        "last-update-time" : "String" ,

        "config-templates" : {

          "@uri" : "/api/space/config-template-management/config-template-definitions/{id}/config-templates",

          "config-template" : {

            "@href" : "/api/space/config-template-management/config-templates/{id}" ,

            "@uri" : "/api/space/config-template-management/config-template-definitions/{id}/config-templates/{id}",

            "id" : "Integer" ,

            "name" : "String"

          }

        } ,

        "domain-name" : "String" ,

        "domain-id" : "Integer" ,

        "domain" : {

          "@href" : "/api/space/domain-management/domains/{domainId}"

        } ,

        "configuration" : {

          "@href" :

          "/api/space/config-template-management/config-template-definitions/{id}/configuration"

        }

      }

 }

Access Control

The following capabilities are required to access this API: ManageTemplateDef

Name	Type	URI Type	Description	Required
id	Integer	Path	The ID of the configuration template definition to retrieve.	Y