Returns a list of MAC filter templates.
Since Product Version: 3.2
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/MacFilterTemplates
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
|
|
description
String
|
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
|
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
WlanProfiles API for getting a list of profiles.
|
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://10.64.88.203/webacs/api/v1/data/MacFilterTemplates/15
<?xml version="1.0" ?>
<queryResponse type="MacFilterTemplates" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/MacFilterTemplates/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
<entity dtoType="macFilterTemplatesDTO" type="MacFilterTemplates" url="https://10.64.88.203/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>
<templateName>String value</templateName>
<tags>
<tag>String value</tag>
<tag>Another string value</tag>
</tags>
</macFilterTemplatesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.88.203/webacs/api/v1/data/MacFilterTemplates/15.json
{
"queryResponse" : {
"@type" : "MacFilterTemplates",
"@responseType" : "getEntity",
"@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/MacFilterTemplates/15",
"@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
"entity" : {
"@dtoType" : "macFilterTemplatesDTO",
"@type" : "MacFilterTemplates",
"@url" : "https : //10.64.88.203/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",
"templateName" : "String value",
"tags" : {
"tag" : ["String value",
"Another 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/MacFilterTemplates
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
|
|
description
String
|
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
|
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
WlanProfiles API for getting a list of profiles.
|
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://10.64.88.203/webacs/api/v2/data/MacFilterTemplates/15
<?xml version="1.0" ?>
<queryResponse type="MacFilterTemplates" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/MacFilterTemplates/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
<entity dtoType="macFilterTemplatesDTO" type="MacFilterTemplates" url="https://10.64.88.203/webacs/api/v2/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>
<templateName>String value</templateName>
<tags>
<tag>String value</tag>
<tag>Another string value</tag>
</tags>
</macFilterTemplatesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.88.203/webacs/api/v2/data/MacFilterTemplates/15.json
{
"queryResponse" : {
"@type" : "MacFilterTemplates",
"@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/MacFilterTemplates/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "macFilterTemplatesDTO",
"@type" : "MacFilterTemplates",
"@url" : "https://10.64.88.203/webacs/api/v2/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", "Another string value" ]
},
"templateName" : "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/MacFilterTemplates
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
|
|
description
String
|
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
|
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
WlanProfiles API for getting a list of profiles.
|
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://10.64.88.203/webacs/api/v3/data/MacFilterTemplates/15
<?xml version="1.0" ?>
<queryResponse type="MacFilterTemplates" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/MacFilterTemplates/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
<entity dtoType="macFilterTemplatesDTO" type="MacFilterTemplates" url="https://10.64.88.203/webacs/api/v3/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>
<templateName>String value</templateName>
<tags>
<tag>String value</tag>
<tag>Another string value</tag>
</tags>
</macFilterTemplatesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.88.203/webacs/api/v3/data/MacFilterTemplates/15.json
{
"queryResponse" : {
"@type" : "MacFilterTemplates",
"@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/MacFilterTemplates/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "macFilterTemplatesDTO",
"@type" : "MacFilterTemplates",
"@url" : "https://10.64.88.203/webacs/api/v3/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", "Another string value" ]
},
"templateName" : "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/MacFilterTemplates
Updated
Since version 4 this API uses a MacFilterTag collection to represent tags.
Response Parameters
author
String
|
|
configContainerId
long
|
|
description
String
|
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
|
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
WlanProfiles API for getting a list of profiles.
|
tags
MacFilterTag[]
|
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://10.64.88.203/webacs/api/v4/data/MacFilterTemplates/15
<?xml version="1.0" ?>
<queryResponse type="MacFilterTemplates" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/MacFilterTemplates/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
<entity dtoType="macFilterTemplatesDTO" type="MacFilterTemplates" url="https://10.64.88.203/webacs/api/v4/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>
<templateName>String value</templateName>
<tags>
<tag>
<name>String value</name>
</tag>
<tag>
<name>Another string value</name>
</tag>
</tags>
</macFilterTemplatesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.88.203/webacs/api/v4/data/MacFilterTemplates/15.json
{
"queryResponse" : {
"@type" : "MacFilterTemplates",
"@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/MacFilterTemplates/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "macFilterTemplatesDTO",
"@type" : "MacFilterTemplates",
"@url" : "https://10.64.88.203/webacs/api/v4/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" : [ {
"name" : "String value"
}, {
"name" : "Another string value"
} ]
},
"templateName" : "String value"
}
} ]
}
}