Represents 802.11 counters collected for radio interfaces of lightweight wireless access points in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time.
Since Product Version: 1.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/HistoricalRFCounters
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
ackFailureCount
long
|
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
failedCount
long
|
|
fcsErrorCount
long
|
|
frameDuplicateCount
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
macAddress
String
|
|
multipleRetryCount
long
|
|
retryCount
long
|
|
rtsFailureCount
long
|
|
rtsSuccessCount
long
|
|
rxFragmentCount
long
|
|
rxMulticastFrameCount
long
|
|
slotId
String
|
|
txFragmentCount
long
|
|
txFrameCount
long
|
|
txMulticastFrameCount
long
|
|
wepUndecryptableCount
long
|
|
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/HistoricalRFCounters/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/HistoricalRFCounters/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://localhost/webacs/api/v1/data/HistoricalRFCounters/15">
<historicalRFCountersDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ackFailureCount>2</ackFailureCount>
<failedCount>2</failedCount>
<fcsErrorCount>2</fcsErrorCount>
<frameDuplicateCount>2</frameDuplicateCount>
<multipleRetryCount>2</multipleRetryCount>
<retryCount>2</retryCount>
<rtsFailureCount>2</rtsFailureCount>
<rtsSuccessCount>2</rtsSuccessCount>
<rxFragmentCount>2</rxFragmentCount>
<rxMulticastFrameCount>2</rxMulticastFrameCount>
<txFragmentCount>2</txFragmentCount>
<txFrameCount>2</txFrameCount>
<txMulticastFrameCount>2</txMulticastFrameCount>
<wepUndecryptableCount>2</wepUndecryptableCount>
<collectionTime>String value</collectionTime>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</historicalRFCountersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/HistoricalRFCounters/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFCounters",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/HistoricalRFCounters\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "historicalRFCountersDTO",
"@type" : "HistoricalRFCounters",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/HistoricalRFCounters\/15",
"historicalRFCountersDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ackFailureCount" : 2,
"failedCount" : 2,
"fcsErrorCount" : 2,
"frameDuplicateCount" : 2,
"multipleRetryCount" : 2,
"retryCount" : 2,
"rtsFailureCount" : 2,
"rtsSuccessCount" : 2,
"rxFragmentCount" : 2,
"rxMulticastFrameCount" : 2,
"txFragmentCount" : 2,
"txFrameCount" : 2,
"txMulticastFrameCount" : 2,
"wepUndecryptableCount" : 2,
"collectionTime" : "String value",
"macAddress" : "String value",
"slotId" : "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/HistoricalRFCounters
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
ackFailureCount
long
|
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
failedCount
long
|
|
fcsErrorCount
long
|
|
frameDuplicateCount
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
macAddress
String
|
|
multipleRetryCount
long
|
|
retryCount
long
|
|
rtsFailureCount
long
|
|
rtsSuccessCount
long
|
|
rxFragmentCount
long
|
|
rxMulticastFrameCount
long
|
|
slotId
String
|
|
txFragmentCount
long
|
|
txFrameCount
long
|
|
txMulticastFrameCount
long
|
|
wepUndecryptableCount
long
|
|
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/HistoricalRFCounters/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/HistoricalRFCounters/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://localhost/webacs/api/v2/data/HistoricalRFCounters/15">
<historicalRFCountersDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ackFailureCount>2</ackFailureCount>
<failedCount>2</failedCount>
<fcsErrorCount>2</fcsErrorCount>
<frameDuplicateCount>2</frameDuplicateCount>
<multipleRetryCount>2</multipleRetryCount>
<retryCount>2</retryCount>
<rtsFailureCount>2</rtsFailureCount>
<rtsSuccessCount>2</rtsSuccessCount>
<rxFragmentCount>2</rxFragmentCount>
<rxMulticastFrameCount>2</rxMulticastFrameCount>
<txFragmentCount>2</txFragmentCount>
<txFrameCount>2</txFrameCount>
<txMulticastFrameCount>2</txMulticastFrameCount>
<wepUndecryptableCount>2</wepUndecryptableCount>
<collectionTime>String value</collectionTime>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</historicalRFCountersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/HistoricalRFCounters/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFCounters",
"@requestUrl" : "https://localhost/webacs/api/v2/data/HistoricalRFCounters/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "historicalRFCountersDTO",
"@type" : "HistoricalRFCounters",
"@url" : "https://localhost/webacs/api/v2/data/HistoricalRFCounters/15",
"historicalRFCountersDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ackFailureCount" : 2,
"collectionTime" : "String value",
"failedCount" : 2,
"fcsErrorCount" : 2,
"frameDuplicateCount" : 2,
"macAddress" : "String value",
"multipleRetryCount" : 2,
"retryCount" : 2,
"rtsFailureCount" : 2,
"rtsSuccessCount" : 2,
"rxFragmentCount" : 2,
"rxMulticastFrameCount" : 2,
"slotId" : "String value",
"txFragmentCount" : 2,
"txFrameCount" : 2,
"txMulticastFrameCount" : 2,
"wepUndecryptableCount" : 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
|
|
Resource URL
/webacs/api/v3/data/HistoricalRFCounters
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
ackFailureCount
long
|
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
failedCount
long
|
|
fcsErrorCount
long
|
|
frameDuplicateCount
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
macAddress
String
|
|
multipleRetryCount
long
|
|
retryCount
long
|
|
rtsFailureCount
long
|
|
rtsSuccessCount
long
|
|
rxFragmentCount
long
|
|
rxMulticastFrameCount
long
|
|
slotId
String
|
|
txFragmentCount
long
|
|
txFrameCount
long
|
|
txMulticastFrameCount
long
|
|
wepUndecryptableCount
long
|
|
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/HistoricalRFCounters/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/HistoricalRFCounters/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://localhost/webacs/api/v3/data/HistoricalRFCounters/15">
<historicalRFCountersDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ackFailureCount>2</ackFailureCount>
<failedCount>2</failedCount>
<fcsErrorCount>2</fcsErrorCount>
<frameDuplicateCount>2</frameDuplicateCount>
<multipleRetryCount>2</multipleRetryCount>
<retryCount>2</retryCount>
<rtsFailureCount>2</rtsFailureCount>
<rtsSuccessCount>2</rtsSuccessCount>
<rxFragmentCount>2</rxFragmentCount>
<rxMulticastFrameCount>2</rxMulticastFrameCount>
<txFragmentCount>2</txFragmentCount>
<txFrameCount>2</txFrameCount>
<txMulticastFrameCount>2</txMulticastFrameCount>
<wepUndecryptableCount>2</wepUndecryptableCount>
<collectionTime>String value</collectionTime>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</historicalRFCountersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/HistoricalRFCounters/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFCounters",
"@requestUrl" : "https://localhost/webacs/api/v3/data/HistoricalRFCounters/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "historicalRFCountersDTO",
"@type" : "HistoricalRFCounters",
"@url" : "https://localhost/webacs/api/v3/data/HistoricalRFCounters/15",
"historicalRFCountersDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ackFailureCount" : 2,
"collectionTime" : "String value",
"failedCount" : 2,
"fcsErrorCount" : 2,
"frameDuplicateCount" : 2,
"macAddress" : "String value",
"multipleRetryCount" : 2,
"retryCount" : 2,
"rtsFailureCount" : 2,
"rtsSuccessCount" : 2,
"rxFragmentCount" : 2,
"rxMulticastFrameCount" : 2,
"slotId" : "String value",
"txFragmentCount" : 2,
"txFrameCount" : 2,
"txMulticastFrameCount" : 2,
"wepUndecryptableCount" : 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
|
|
Resource URL
/webacs/api/v4/data/HistoricalRFCounters
Updated
Since version 4 types of attributes macAddress, slotId and collectionTime have been changed.
Response Parameters
ackFailureCount
long
|
|
collectionTime
Date
|
The time collection of this record was finished.
Note: The date has an incorrect UTC offset. Add the appliance UTC offset to get the correct date.
|
failedCount
long
|
|
fcsErrorCount
long
|
|
frameDuplicateCount
long
|
|
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
macAddress
MacAddress
|
|
multipleRetryCount
long
|
|
retryCount
long
|
|
rtsFailureCount
long
|
|
rtsSuccessCount
long
|
|
rxFragmentCount
long
|
|
rxMulticastFrameCount
long
|
|
slotId
int
|
|
txFragmentCount
long
|
|
txFrameCount
long
|
|
txMulticastFrameCount
long
|
|
wepUndecryptableCount
long
|
|
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/HistoricalRFCounters/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/HistoricalRFCounters/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://localhost/webacs/api/v4/data/HistoricalRFCounters/15">
<historicalRFCountersDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ackFailureCount>2</ackFailureCount>
<failedCount>2</failedCount>
<fcsErrorCount>2</fcsErrorCount>
<frameDuplicateCount>2</frameDuplicateCount>
<multipleRetryCount>2</multipleRetryCount>
<retryCount>2</retryCount>
<rtsFailureCount>2</rtsFailureCount>
<rtsSuccessCount>2</rtsSuccessCount>
<rxFragmentCount>2</rxFragmentCount>
<rxMulticastFrameCount>2</rxMulticastFrameCount>
<txFragmentCount>2</txFragmentCount>
<txFrameCount>2</txFrameCount>
<txMulticastFrameCount>2</txMulticastFrameCount>
<wepUndecryptableCount>2</wepUndecryptableCount>
<collectionTime>2018-12-21T12:10:21.917+07:00</collectionTime>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<slotId>1</slotId>
</historicalRFCountersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/HistoricalRFCounters/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFCounters",
"@requestUrl" : "https://localhost/webacs/api/v4/data/HistoricalRFCounters/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "historicalRFCountersDTO",
"@type" : "HistoricalRFCounters",
"@url" : "https://localhost/webacs/api/v4/data/HistoricalRFCounters/15",
"historicalRFCountersDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ackFailureCount" : 2,
"collectionTime" : "2018-12-21T05:10:21.917Z",
"failedCount" : 2,
"fcsErrorCount" : 2,
"frameDuplicateCount" : 2,
"macAddress" : {
"octets" : "000a959d6816"
},
"multipleRetryCount" : 2,
"retryCount" : 2,
"rtsFailureCount" : 2,
"rtsSuccessCount" : 2,
"rxFragmentCount" : 2,
"rxMulticastFrameCount" : 2,
"slotId" : 1,
"txFragmentCount" : 2,
"txFrameCount" : 2,
"txMulticastFrameCount" : 2,
"wepUndecryptableCount" : 2
}
} ]
}
}