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

GET UserDefinedGroups

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/userDefinedGroups.

Provides the list of User Defined groups and the associated sub group hierarchy. Note that internally, UserDefinedGroups 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/UserDefinedGroups

Response Parameters

Type Attribute Name Description

int

clearedAlarms

Number of cleared alarms registered against devices within this site.

int

criticalAlarms

Number of critical alarms registered against devices within this site.

long

groupId

The internal instance id of the user defined group.

String

groupName

The name of the user defined group

int

informationAlarms

Number of information alarms registered against devices within this site.

String

instanceUuid

This is a uuid for this instance.

int

majorAlarms

Number of major alarms registered against devices within this site.

int

minorAlarms

Number of minor alarms registered against devices within this site.

String

name

The hierarchical name of the group.

int

warningAlarms

Number of warning alarms registered against devices within this site.

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/UserDefinedGroups/15

<?xml version="1.0" ?>
<queryResponse type="UserDefinedGroups" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/UserDefinedGroups/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="userDefinedGroupsDTO" type="UserDefinedGroups" url="https://172.25.123.114/webacs/api/v1/data/UserDefinedGroups/15">
    <userDefinedGroupsDTO displayName="String value" id="15" uuid="String value">
      <clearedAlarms>1</clearedAlarms>
      <criticalAlarms>1</criticalAlarms>
      <groupId>2</groupId>
      <groupName>String value</groupName>
      <informationAlarms>1</informationAlarms>
      <majorAlarms>1</majorAlarms>
      <minorAlarms>1</minorAlarms>
      <name>String value</name>
      <warningAlarms>1</warningAlarms>
    </userDefinedGroupsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "UserDefinedGroups",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/UserDefinedGroups\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "userDefinedGroupsDTO",
      "@type" : "UserDefinedGroups",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/UserDefinedGroups\/15",
      "userDefinedGroupsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "clearedAlarms" : 1,
        "criticalAlarms" : 1,
        "groupId" : 2,
        "groupName" : "String value",
        "informationAlarms" : 1,
        "majorAlarms" : 1,
        "minorAlarms" : 1,
        "name" : "String value",
        "warningAlarms" : 1
      }
    }
  }
}