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

GET Sites

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Deprecated

Do not use this resource. Replaced by /op/groups/sites.

This provides information about the location groups and its hierarchy of campus and buildings. Note that internally, Locations are type of "Group", and thus all children will be of the generic type "subGroup".

Since Product Version: 1.2

Resource URL

/webacs/api/v1/data/Sites

Response Parameters

Type Attribute Name Description

int

apCount

The number of Access Points (Unified or Autonomous) within the location.

int

clearedAlarms

Number of cleared alarms registered against devices within this location.

int

clientCount

Number of clients connected to the location.

int

criticalAlarms

Number of critical alarms registered against devices within this location.

int

deviceCount

Total number of devices (excluding Unified APs).

long

groupId

The internal id of the location group.

String

groupName

The name of the location group.

int

informationAlarms

Number of information alarms registered against devices within this location.

String

instanceUuid

This is a uuid for this instance.

Float

latitude

Latitude of location.

String

locationAddress

Address of location.

Float

longitude

Longitude of location.

int

majorAlarms

Number of major alarms registered against devices within this location.

int

minorAlarms

Number of minor alarms registered against devices within this location.

String

name

The hierarchical name of the location.

String

siteType

The type of location: 1 Campus, 2 Building, 4 Floor Area, 5 Outdoor Area.

int

warningAlarms

Number of warning alarms registered against devices within this location.

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://172.25.123.114/webacs/api/v1/data/Sites/15

<?xml version="1.0" ?>
<queryResponse type="Sites" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/Sites/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="sitesDTO" type="Sites" url="https://172.25.123.114/webacs/api/v1/data/Sites/15">
    <sitesDTO displayName="String value" id="15" uuid="String value">
      <apCount>1</apCount>
      <clearedAlarms>1</clearedAlarms>
      <clientCount>1</clientCount>
      <criticalAlarms>1</criticalAlarms>
      <deviceCount>1</deviceCount>
      <groupId>2</groupId>
      <groupName>String value</groupName>
      <informationAlarms>1</informationAlarms>
      <latitude>15.0</latitude>
      <locationAddress>String value</locationAddress>
      <longitude>15.0</longitude>
      <majorAlarms>1</majorAlarms>
      <minorAlarms>1</minorAlarms>
      <name>String value</name>
      <siteType>String value</siteType>
      <warningAlarms>1</warningAlarms>
    </sitesDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/Sites/15.json

{
  "queryResponse" : {
    "@type" : "Sites",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Sites\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "sitesDTO",
      "@type" : "Sites",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Sites\/15",
      "sitesDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "apCount" : 1,
        "clearedAlarms" : 1,
        "clientCount" : 1,
        "criticalAlarms" : 1,
        "deviceCount" : 1,
        "groupId" : 2,
        "groupName" : "String value",
        "informationAlarms" : 1,
        "latitude" : 15,
        "locationAddress" : "String value",
        "longitude" : 15,
        "majorAlarms" : 1,
        "minorAlarms" : 1,
        "name" : "String value",
        "siteType" : "String value",
        "warningAlarms" : 1
      }
    }
  }
}