Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET CliTemplate

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

CLI configuration templates.

Since Product Version: 2.2

Resource URL

/webacs/api/v1/data/CliTemplate

Response Parameters

Type Attribute Name Description

String

author

Template author

String

content

Content of the template.

Date

createdOn

Time when template was ceated or uploaded

long

deployCount

Number of successfull deployments of this template

String

description

Human-readable description of the template.

String

deviceType

Comma-separated list of devices on which the template is allowed to be deployed.

String

instanceUuid

This is a uuid for this instance.

Date

lastDeployTime

Time of last succesfull deployment of this template

String

name

Name of the template

String

path

Full name of folder where template is stored.

String

tags

Tags list separated by comma

long

templateId

CliTemplateVariable[]

variable

CLI Template variables used in content. Variables have the same order in which they were created

String

version

iOS version

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Payload

https://172.25.123.114/webacs/api/v1/data/CliTemplate/15

<?xml version="1.0" ?>
<queryResponse type="CliTemplate" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/CliTemplate/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="cliTemplateDTO" type="CliTemplate" url="https://172.25.123.114/webacs/api/v1/data/CliTemplate/15">
    <cliTemplateDTO displayName="String value" id="15" uuid="String value">
      <author>String value</author>
      <content>String value</content>
      <createdOn>2020-07-28T20:26:40.727Z</createdOn>
      <deployCount>2</deployCount>
      <description>String value</description>
      <deviceType>String value</deviceType>
      <lastDeployTime>2020-07-28T20:26:40.727Z</lastDeployTime>
      <name>String value</name>
      <path>String value</path>
      <tags>String value</tags>
      <templateId>2</templateId>
      <variables>
        <variable>
          <defaultValue>String value</defaultValue>
          <description>String value</description>
          <displayLabel>String value</displayLabel>
          <name>String value</name>
          <rangeFrom>String value</rangeFrom>
          <rangeTo>String value</rangeTo>
          <required>String value</required>
          <type>String value</type>
          <validationExpression>String value</validationExpression>
        </variable>
      </variables>
      <version>String value</version>
    </cliTemplateDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/CliTemplate/15.json

{
  "queryResponse" : {
    "@type" : "CliTemplate",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/CliTemplate\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "cliTemplateDTO",
      "@type" : "CliTemplate",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/CliTemplate\/15",
      "cliTemplateDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "author" : "String value",
        "content" : "String value",
        "createdOn" : "2020-07-28T20 : 26 : 40.727Z",
        "deployCount" : 2,
        "description" : "String value",
        "deviceType" : "String value",
        "lastDeployTime" : "2020-07-28T20 : 26 : 40.727Z",
        "name" : "String value",
        "path" : "String value",
        "tags" : "String value",
        "templateId" : 2,
        "variables" : {
          "variable" : {
            "defaultValue" : "String value",
            "description" : "String value",
            "displayLabel" : "String value",
            "name" : "String value",
            "rangeFrom" : "String value",
            "rangeTo" : "String value",
            "required" : "String value",
            "type" : "String value",
            "validationExpression" : "String value"
          }
        },
        "version" : "String value"
      }
    }
  }
}