Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/cliTemplateConfiguration/template
Request Payload Parameters
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
|
Required
The types of devices this template is applicable for, comma seperated.
|
name
String
|
Required
The name of the template.
|
path
String
|
|
tags
String
|
Tags list separated by comma
|
variables
CliTemplateVariableDefinition[]
|
A list of variables needed for this template
|
defaultValue
String
|
A default value if the value is not specified when deployed.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
A description of the variable.
|
displayLabel
String
|
Variable name to be displayed in the UI.
|
name
String
|
|
rangeFrom
String
|
The minimum allowed value for Integer variables. For other varaible types this field is ignored.
|
rangeTo
String
|
The maximum allowed value for Integer variables. For other varaible types this field is ignored.
|
required
boolean
|
Does the variable have to be set?
|
type
String
|
The variable type.
Supported values: Checkbox, DB, DB_Dropdown, Dropdown, Integer, IPv4 Address, Radio Button, String, Text Area.
|
validationExpression
String
|
The regular expression for validating variable value.
Supported for variable types: DB, Integer, IPv4 Address, String, Text Area.
|
|
version
String
|
|
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 Request Payload
https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/template
<?xml version="1.0" ?>
<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>
<variable>
<defaultValue>Another string value</defaultValue>
<description>Another string value</description>
<displayLabel>Another string value</displayLabel>
<name>Another string value</name>
<rangeFrom>Another string value</rangeFrom>
<rangeTo>Another string value</rangeTo>
<required>false</required>
<type>Another string value</type>
<validationExpression>Another string value</validationExpression>
</variable>
</variables>
<version>String value</version>
</cliTemplate>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v1/op/cliTemplateConfiguration/template.json
{
"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"
},
{
"defaultValue" : "Another string value",
"description" : "Another string value",
"displayLabel" : "Another string value",
"name" : "Another string value",
"rangeFrom" : "Another string value",
"rangeTo" : "Another string value",
"required" : false,
"type" : "Another string value",
"validationExpression" : "Another string value"
}]
},
"version" : "String value"
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/cliTemplateConfiguration/template
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
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
|
Required
The types of devices this template is applicable for, comma seperated.
|
name
String
|
Required
The name of the template.
|
path
String
|
|
tags
String
|
Tags list separated by comma
|
variables
CliTemplateVariableDefinition[]
|
A list of variables needed for this template
|
defaultValue
String
|
A default value if the value is not specified when deployed.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
A description of the variable.
|
displayLabel
String
|
Variable name to be displayed in the UI.
|
name
String
|
|
rangeFrom
String
|
The minimum allowed value for Integer variables. For other varaible types this field is ignored.
|
rangeTo
String
|
The maximum allowed value for Integer variables. For other varaible types this field is ignored.
|
required
boolean
|
Does the variable have to be set?
|
type
String
|
The variable type.
Supported values: Checkbox, DB, DB_Dropdown, Dropdown, Integer, IPv4 Address, Radio Button, String, Text Area.
|
validationExpression
String
|
The regular expression for validating variable value.
Supported for variable types: DB, Integer, IPv4 Address, String, Text Area.
|
|
version
String
|
|
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 Request Payload
https://172.20.127.108/webacs/api/v2/op/cliTemplateConfiguration/template
<?xml version="1.0" ?>
<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>
<variable>
<defaultValue>Another string value</defaultValue>
<description>Another string value</description>
<displayLabel>Another string value</displayLabel>
<name>Another string value</name>
<rangeFrom>Another string value</rangeFrom>
<rangeTo>Another string value</rangeTo>
<required>false</required>
<type>Another string value</type>
<validationExpression>Another string value</validationExpression>
</variable>
</variables>
<version>String value</version>
</cliTemplate>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v2/op/cliTemplateConfiguration/template.json
{
"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"
}, {
"defaultValue" : "Another string value",
"description" : "Another string value",
"displayLabel" : "Another string value",
"name" : "Another string value",
"rangeFrom" : "Another string value",
"rangeTo" : "Another string value",
"required" : false,
"type" : "Another string value",
"validationExpression" : "Another string value"
} ]
},
"version" : "String value"
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/cliTemplateConfiguration/template
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
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
|
Required
The types of devices this template is applicable for, comma seperated.
|
name
String
|
Required
The name of the template.
|
path
String
|
|
tags
String
|
Tags list separated by comma
|
variables
CliTemplateVariableDefinition[]
|
A list of variables needed for this template
|
defaultValue
String
|
A default value if the value is not specified when deployed.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
A description of the variable.
|
displayLabel
String
|
Variable name to be displayed in the UI.
|
name
String
|
|
rangeFrom
String
|
The minimum allowed value for Integer variables. For other varaible types this field is ignored.
|
rangeTo
String
|
The maximum allowed value for Integer variables. For other varaible types this field is ignored.
|
required
boolean
|
Does the variable have to be set?
|
type
String
|
The variable type.
Supported values: Checkbox, DB, DB_Dropdown, Dropdown, Integer, IPv4 Address, Radio Button, String, Text Area.
|
validationExpression
String
|
The regular expression for validating variable value.
Supported for variable types: DB, Integer, IPv4 Address, String, Text Area.
|
|
version
String
|
|
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 Request Payload
https://172.20.127.108/webacs/api/v3/op/cliTemplateConfiguration/template
<?xml version="1.0" ?>
<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>
<variable>
<defaultValue>Another string value</defaultValue>
<description>Another string value</description>
<displayLabel>Another string value</displayLabel>
<name>Another string value</name>
<rangeFrom>Another string value</rangeFrom>
<rangeTo>Another string value</rangeTo>
<required>false</required>
<type>Another string value</type>
<validationExpression>Another string value</validationExpression>
</variable>
</variables>
<version>String value</version>
</cliTemplate>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v3/op/cliTemplateConfiguration/template.json
{
"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"
}, {
"defaultValue" : "Another string value",
"description" : "Another string value",
"displayLabel" : "Another string value",
"name" : "Another string value",
"rangeFrom" : "Another string value",
"rangeTo" : "Another string value",
"required" : false,
"type" : "Another string value",
"validationExpression" : "Another string value"
} ]
},
"version" : "String value"
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/cliTemplateConfiguration/template
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
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
|
Required
The types of devices this template is applicable for, comma seperated.
|
name
String
|
Required
The name of the template.
|
path
String
|
|
tags
String
|
Tags list separated by comma
|
variables
CliTemplateVariableDefinition[]
|
A list of variables needed for this template
|
defaultValue
String
|
A default value if the value is not specified when deployed.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
A description of the variable.
|
displayLabel
String
|
Variable name to be displayed in the UI.
|
name
String
|
|
rangeFrom
String
|
The minimum allowed value for Integer variables. For other varaible types this field is ignored.
|
rangeTo
String
|
The maximum allowed value for Integer variables. For other varaible types this field is ignored.
|
required
boolean
|
Does the variable have to be set?
|
type
String
|
The variable type.
Supported values: Checkbox, DB, DB_Dropdown, Dropdown, Integer, IPv4 Address, Radio Button, String, Text Area.
|
validationExpression
String
|
The regular expression for validating variable value.
Supported for variable types: DB, Integer, IPv4 Address, String, Text Area.
|
|
version
String
|
|
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 Request Payload
https://172.20.127.108/webacs/api/v4/op/cliTemplateConfiguration/template
<?xml version="1.0" ?>
<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>
<variable>
<defaultValue>Another string value</defaultValue>
<description>Another string value</description>
<displayLabel>Another string value</displayLabel>
<name>Another string value</name>
<rangeFrom>Another string value</rangeFrom>
<rangeTo>Another string value</rangeTo>
<required>false</required>
<type>Another string value</type>
<validationExpression>Another string value</validationExpression>
</variable>
</variables>
<version>String value</version>
</cliTemplate>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v4/op/cliTemplateConfiguration/template.json
{
"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"
}, {
"defaultValue" : "Another string value",
"description" : "Another string value",
"displayLabel" : "Another string value",
"name" : "Another string value",
"rangeFrom" : "Another string value",
"rangeTo" : "Another string value",
"required" : false,
"type" : "Another string value",
"validationExpression" : "Another string value"
} ]
},
"version" : "String value"
}
}