CLI configuration templates.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
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/data/CliTemplate
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of tags.
Response Parameters
author
String
|
|
configContainerId
long
|
|
content
String
|
|
createdOn
Date
|
Time when template was created or uploaded
|
deployCount
long
|
Number of deployments of this template
|
deployJobCount
long
|
Number of jobs to deploy this template
|
description
String
|
Human-readable description of the template
|
deviceType
String
|
Comma-separated list of devices on which the template is allowed to be deployed
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
lastDeployTime
Date
|
Time of last successful deployment of this template
|
name
String
|
|
path
String
|
Full name of folder where the template is stored
|
tags
String
|
Tag list separated by comma
|
templateId
long
|
|
userTags
String[]
|
|
variable
CliTemplateVariable[]
|
CLI Template variables used in content. Variables have the same order in which they were created
|
defaultValue
String
|
Variable's default value.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
Variable's human-readable description.
|
displayLabel
String
|
Label 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
String
|
Is this variable required to be assigned to a value?
|
type
String
|
Variable's data 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 Payload
https://localhost/webacs/api/v1/data/CliTemplate/15
<?xml version="1.0" ?>
<queryResponse type="CliTemplate" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/CliTemplate/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="cliTemplateDTO" type="CliTemplate" url="https://localhost/webacs/api/v1/data/CliTemplate/15">
<cliTemplateDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<author>String value</author>
<configContainerId>2</configContainerId>
<content>String value</content>
<createdOn>2018-12-21T12:09:15.293+07:00</createdOn>
<deployCount>2</deployCount>
<deployJobCount>2</deployJobCount>
<description>String value</description>
<deviceType>String value</deviceType>
<lastDeployTime>2018-12-21T12:09:15.293+07:00</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>
<userTags>
<userTag>String value</userTag>
</userTags>
</cliTemplateDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/CliTemplate/15.json
{
"queryResponse" : {
"@type" : "CliTemplate",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/CliTemplate\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "cliTemplateDTO",
"@type" : "CliTemplate",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/CliTemplate\/15",
"cliTemplateDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"author" : "String value",
"configContainerId" : 2,
"content" : "String value",
"createdOn" : "2018-12-21T12 : 09 : 15.293+07 : 00",
"deployCount" : 2,
"deployJobCount" : 2,
"description" : "String value",
"deviceType" : "String value",
"lastDeployTime" : "2018-12-21T12 : 09 : 15.293+07 : 00",
"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",
"userTags" : {
"userTag" : "String value"
}
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/CliTemplate
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of tags.
Response Parameters
author
String
|
|
configContainerId
long
|
|
content
String
|
|
createdOn
Date
|
Time when template was created or uploaded
|
deployCount
long
|
Number of deployments of this template
|
deployJobCount
long
|
Number of jobs to deploy this template
|
description
String
|
Human-readable description of the template
|
deviceType
String
|
Comma-separated list of devices on which the template is allowed to be deployed
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
lastDeployTime
Date
|
Time of last successful deployment of this template
|
name
String
|
|
path
String
|
Full name of folder where the template is stored
|
tags
String
|
Tag list separated by comma
|
templateId
long
|
|
userTags
String[]
|
|
variable
CliTemplateVariable[]
|
CLI Template variables used in content. Variables have the same order in which they were created
|
defaultValue
String
|
Variable's default value.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
Variable's human-readable description.
|
displayLabel
String
|
Label 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
String
|
Is this variable required to be assigned to a value?
|
type
String
|
Variable's data 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 Payload
https://localhost/webacs/api/v2/data/CliTemplate/15
<?xml version="1.0" ?>
<queryResponse type="CliTemplate" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/CliTemplate/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="cliTemplateDTO" type="CliTemplate" url="https://localhost/webacs/api/v2/data/CliTemplate/15">
<cliTemplateDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<author>String value</author>
<configContainerId>2</configContainerId>
<content>String value</content>
<createdOn>2018-12-21T12:09:15.301+07:00</createdOn>
<deployCount>2</deployCount>
<deployJobCount>2</deployJobCount>
<description>String value</description>
<deviceType>String value</deviceType>
<lastDeployTime>2018-12-21T12:09:15.301+07:00</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>
<userTags>
<userTag>String value</userTag>
</userTags>
</cliTemplateDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/CliTemplate/15.json
{
"queryResponse" : {
"@type" : "CliTemplate",
"@requestUrl" : "https://localhost/webacs/api/v2/data/CliTemplate/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "cliTemplateDTO",
"@type" : "CliTemplate",
"@url" : "https://localhost/webacs/api/v2/data/CliTemplate/15",
"cliTemplateDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"author" : "String value",
"configContainerId" : 2,
"content" : "String value",
"createdOn" : 1545368955301,
"deployCount" : 2,
"deployJobCount" : 2,
"description" : "String value",
"deviceType" : "String value",
"lastDeployTime" : 1545368955301,
"name" : "String value",
"path" : "String value",
"tags" : "String value",
"templateId" : 2,
"userTags" : {
"userTag" : [ "String value" ]
},
"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"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/CliTemplate
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of tags.
Response Parameters
author
String
|
|
configContainerId
long
|
|
content
String
|
|
createdOn
Date
|
Time when template was created or uploaded
|
deployCount
long
|
Number of deployments of this template
|
deployJobCount
long
|
Number of jobs to deploy this template
|
description
String
|
Human-readable description of the template
|
deviceType
String
|
Comma-separated list of devices on which the template is allowed to be deployed
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
lastDeployTime
Date
|
Time of last successful deployment of this template
|
name
String
|
|
path
String
|
Full name of folder where the template is stored
|
tags
String
|
Tag list separated by comma
|
templateId
long
|
|
userTags
String[]
|
|
variable
CliTemplateVariable[]
|
CLI Template variables used in content. Variables have the same order in which they were created
|
defaultValue
String
|
Variable's default value.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
Variable's human-readable description.
|
displayLabel
String
|
Label 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
String
|
Is this variable required to be assigned to a value?
|
type
String
|
Variable's data 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 Payload
https://localhost/webacs/api/v3/data/CliTemplate/15
<?xml version="1.0" ?>
<queryResponse type="CliTemplate" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/CliTemplate/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="cliTemplateDTO" type="CliTemplate" url="https://localhost/webacs/api/v3/data/CliTemplate/15">
<cliTemplateDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<author>String value</author>
<configContainerId>2</configContainerId>
<content>String value</content>
<createdOn>2018-12-21T12:09:15.303+07:00</createdOn>
<deployCount>2</deployCount>
<deployJobCount>2</deployJobCount>
<description>String value</description>
<deviceType>String value</deviceType>
<lastDeployTime>2018-12-21T12:09:15.304+07:00</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>
<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>Another string value</required>
<type>Another string value</type>
<validationExpression>Another string value</validationExpression>
</variable>
</variables>
<version>String value</version>
<userTags>
<userTag>String value</userTag>
<userTag>Another string value</userTag>
</userTags>
</cliTemplateDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/CliTemplate/15.json
{
"queryResponse" : {
"@type" : "CliTemplate",
"@requestUrl" : "https://localhost/webacs/api/v3/data/CliTemplate/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "cliTemplateDTO",
"@type" : "CliTemplate",
"@url" : "https://localhost/webacs/api/v3/data/CliTemplate/15",
"cliTemplateDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"author" : "String value",
"configContainerId" : 2,
"content" : "String value",
"createdOn" : "2018-12-21T05:09:15.303Z",
"deployCount" : 2,
"deployJobCount" : 2,
"description" : "String value",
"deviceType" : "String value",
"lastDeployTime" : "2018-12-21T05:09:15.304Z",
"name" : "String value",
"path" : "String value",
"tags" : "String value",
"templateId" : 2,
"userTags" : {
"userTag" : [ "String value", "Another string value" ]
},
"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"
}, {
"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" : "Another string value",
"type" : "Another string value",
"validationExpression" : "Another string value"
} ]
},
"version" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/CliTemplate
Updated
Since version 4 this API uses a CliTag collection to represent tags.
Response Parameters
author
String
|
|
configContainerId
long
|
|
content
String
|
|
createdOn
Date
|
Time when template was created or uploaded
|
deployCount
long
|
Number of deployments of this template
|
deployJobCount
long
|
Number of jobs to deploy this template
|
description
String
|
Human-readable description of the template
|
deviceType
String
|
Comma-separated list of devices on which the template is allowed to be deployed
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
lastDeployTime
Date
|
Time of last successful deployment of this template
|
name
String
|
|
path
String
|
Full name of folder where the template is stored
|
tags
String
|
Tag list separated by comma
|
templateId
long
|
|
userTags
CliTag[]
|
|
|
variable
CliTemplateVariable[]
|
CLI Template variables used in content. Variables have the same order in which they were created
|
defaultValue
String
|
Variable's default value.
Contains comma-separated list of values for following variable types: DB_Dropdown, Dropdown, Radio Button. For other variable types contains single value.
|
description
String
|
Variable's human-readable description.
|
displayLabel
String
|
Label 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
String
|
Is this variable required to be assigned to a value?
|
type
String
|
Variable's data 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 Payload
https://localhost/webacs/api/v4/data/CliTemplate/15
<?xml version="1.0" ?>
<queryResponse type="CliTemplate" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/CliTemplate/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="cliTemplateDTO" type="CliTemplate" url="https://localhost/webacs/api/v4/data/CliTemplate/15">
<cliTemplateDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<author>String value</author>
<configContainerId>2</configContainerId>
<content>String value</content>
<createdOn>2018-12-21T12:09:15.306+07:00</createdOn>
<deployCount>2</deployCount>
<deployJobCount>2</deployJobCount>
<description>String value</description>
<deviceType>String value</deviceType>
<lastDeployTime>2018-12-21T12:09:15.306+07:00</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>
<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>Another string value</required>
<type>Another string value</type>
<validationExpression>Another string value</validationExpression>
</variable>
</variables>
<version>String value</version>
<userTags>
<userTag>
<name>String value</name>
</userTag>
<userTag>
<name>Another string value</name>
</userTag>
</userTags>
</cliTemplateDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/CliTemplate/15.json
{
"queryResponse" : {
"@type" : "CliTemplate",
"@requestUrl" : "https://localhost/webacs/api/v4/data/CliTemplate/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "cliTemplateDTO",
"@type" : "CliTemplate",
"@url" : "https://localhost/webacs/api/v4/data/CliTemplate/15",
"cliTemplateDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"author" : "String value",
"configContainerId" : 2,
"content" : "String value",
"createdOn" : "2018-12-21T05:09:15.306Z",
"deployCount" : 2,
"deployJobCount" : 2,
"description" : "String value",
"deviceType" : "String value",
"lastDeployTime" : "2018-12-21T05:09:15.306Z",
"name" : "String value",
"path" : "String value",
"tags" : "String value",
"templateId" : 2,
"userTags" : {
"userTag" : [ {
"name" : "String value"
}, {
"name" : "Another string value"
} ]
},
"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"
}, {
"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" : "Another string value",
"type" : "Another string value",
"validationExpression" : "Another string value"
} ]
},
"version" : "String value"
}
} ]
}
}