Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.
Export a template from the system.
Since Product Version: 2.0
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v2/op/cliTemplateConfiguration/download UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
templateName String |
query |
Required Template to export. |
Response Parameters
Attribute | Description |
---|---|
content String |
The content of the template that will be populated with variable values and sent to devices. |
description String |
A description of the template |
deviceType String |
The types of devices this template is applicable for, comma seperated. |
name String |
The name of the template. |
path String |
Template path |
Tags list separated by comma |
|
A list of variables needed for this template |
|
version String |
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 Response Payload
https://localhost/webacs/api/v2/op/cliTemplateConfiguration/download?templateName=name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/cliTemplateConfiguration/download?templateName=name" rootUrl="https://localhost/webacs/api/v2/op">
<cliTemplate>
<content>String value</content>
<description>String value</description>
<deviceType>String value</deviceType>
<name>String value</name>
<path>String value</path>
<tags>String value</tags>
<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>true</required>
<type>String value</type>
<validationExpression>String value</validationExpression>
</variable>
</variables>
<version>String value</version>
</cliTemplate>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/cliTemplateConfiguration/download.json?templateName=name
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/cliTemplateConfiguration/download?templateName=name",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"cliTemplate" : [ {
"content" : "String value",
"description" : "String value",
"deviceType" : "String value",
"name" : "String value",
"path" : "String value",
"tags" : "String value",
"variables" : {
"variable" : [ {
"defaultValue" : "String value",
"description" : "String value",
"displayLabel" : "String value",
"name" : "String value",
"rangeFrom" : "String value",
"rangeTo" : "String value",
"required" : true,
"type" : "String value",
"validationExpression" : "String value"
} ]
},
"version" : "String value"
} ]
}
}