Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET statisticsService/circuits

Fetches the circuit basic details, in addition to the url for the next step that is available under the "metricsLink" element. Example: /op/statisticsService/circuits?.full=true&circuitName=EvcLink_EthPwLink%23EPW_50.50.50.50

Since Product Version: 2.0

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

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/circuits

Request Parameters

Attribute Source Description

circuitName String

query

Required

Circuit name.

Response Parameters

Attribute Description

resources Arrow image ResourceDetailsDTO[]

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://172.20.127.108/webacs/api/v1/op/statisticsService/circuits

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v1/op/statisticsService/circuits.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/statisticsService\/circuits",
    "@rootUrl" : "https : \/\/172.20.127.108\/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"
        }]
      }
    }
  }
}