Returns a list of MAC filter templates.
Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/data/MacFilterTemplatesResponse Parameters
Attribute | Description |
---|---|
author String |
Template author |
configContainerId long |
Config container ID |
description String |
The description of the MAC filter template. |
deviceType MacFilterDeviceTypeEnum |
The device type. Allowed values: |
interfaceName String |
The name of the WLAN interface. |
macAddress MacAddress |
The MAC address. |
path String |
Full name of folder where the template is stored. |
profileName String |
The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'. You can use the following API for getting a list of profiles: /data/WlanProfiles?.full=true |
tags String[] |
List of tags which are used for grouping templates. |
templateName String |
The name of the MAC filter template. |
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/MacFilterTemplates/15
<?xml version="1.0" ?>
<queryResponse type="MacFilterTemplates" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/MacFilterTemplates/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="macFilterTemplatesDTO" type="MacFilterTemplates" url="https://localhost/webacs/api/v1/data/MacFilterTemplates/15">
<macFilterTemplatesDTO displayName="String value" id="15" uuid="String value">
<author>String value</author>
<configContainerId>2</configContainerId>
<description>String value</description>
<deviceType>CUWN</deviceType>
<interfaceName>String value</interfaceName>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<path>String value</path>
<profileName>String value</profileName>
<tags>
<tag>String value</tag>
</tags>
<templateName>String value</templateName>
</macFilterTemplatesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/MacFilterTemplates/15.json
{
"queryResponse" : {
"@type" : "MacFilterTemplates",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/MacFilterTemplates\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "macFilterTemplatesDTO",
"@type" : "MacFilterTemplates",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/MacFilterTemplates\/15",
"macFilterTemplatesDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"author" : "String value",
"configContainerId" : 2,
"description" : "String value",
"deviceType" : "CUWN",
"interfaceName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"path" : "String value",
"profileName" : "String value",
"tags" : {
"tag" : "String value"
},
"templateName" : "String value"
}
}
}
}