Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
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/op/statisticsService/bngIp
Request Parameters
device
String
|
query
|
Optional
Defines the IP address of the device to which the IP pool instance belongs.
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Defines a comma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
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 Response Payload
https://10.56.58.149/webacs/api/v1/op/statisticsService/bngIp
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/statisticsService/bngIp" rootUrl="https://10.56.58.149/webacs/api/v1/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
<resources>
<childrenLink>Another string value</childrenLink>
<description>Another string value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>Another string value</metricsLink>
<name>Another string value</name>
<type>Another string value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v1/op/statisticsService/bngIp.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/statisticsService\/bngIp",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
"resourcesDTO" : {
"resources" : {
"resources" : [{
"childrenLink" : "String value",
"description" : "String value",
"details" : {
"item" : [{
"@key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"@key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
},
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
},
{
"childrenLink" : "Another string value",
"description" : "Another string value",
"details" : {
"item" : [{
"@key" : "Another string value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "Another string value"
}
},
{
"@key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}]
},
"metricsLink" : "Another string value",
"name" : "Another string value",
"type" : "Another string value"
}]
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/bngIp
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
Optional
Defines the IP address of the device to which the IP pool instance belongs.
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Defines a comma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
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 Response Payload
https://10.56.58.149/webacs/api/v2/op/statisticsService/bngIp
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v2/op/statisticsService/bngIp" rootUrl="https://10.56.58.149/webacs/api/v2/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
<resources>
<childrenLink>Another string value</childrenLink>
<description>Another string value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>Another string value</metricsLink>
<name>Another string value</name>
<type>Another string value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v2/op/statisticsService/bngIp.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v2/op/statisticsService/bngIp",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v2/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
}, {
"childrenLink" : "Another string value",
"description" : "Another string value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "Another string value",
"name" : "Another string value",
"type" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/bngIp
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
Optional
Defines the IP address of the device to which the IP pool instance belongs.
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Defines a comma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
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 Response Payload
https://10.56.58.149/webacs/api/v3/op/statisticsService/bngIp
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v3/op/statisticsService/bngIp" rootUrl="https://10.56.58.149/webacs/api/v3/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
<resources>
<childrenLink>Another string value</childrenLink>
<description>Another string value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>Another string value</metricsLink>
<name>Another string value</name>
<type>Another string value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v3/op/statisticsService/bngIp.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v3/op/statisticsService/bngIp",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v3/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
}, {
"childrenLink" : "Another string value",
"description" : "Another string value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "Another string value",
"name" : "Another string value",
"type" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/bngIp
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
Optional
Defines the IP address of the device to which the IP pool instance belongs.
|
firstResult
Integer
|
query
|
Optional
Defines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
Optional
Defines the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
Optional
Defines a comma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
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 Response Payload
https://10.56.58.149/webacs/api/v4/op/statisticsService/bngIp
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v4/op/statisticsService/bngIp" rootUrl="https://10.56.58.149/webacs/api/v4/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
<resources>
<childrenLink>Another string value</childrenLink>
<description>Another string value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>Another string value</metricsLink>
<name>Another string value</name>
<type>Another string value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v4/op/statisticsService/bngIp.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v4/op/statisticsService/bngIp",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v4/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
}, {
"childrenLink" : "Another string value",
"description" : "Another string value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "Another string value",
"name" : "Another string value",
"type" : "Another string value"
} ]
}
} ]
}
}