Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_DeviceGroups

# GET DeviceGroups

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
HTTP Methods | GET

Deprecated

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

This provides information about the hierarchy of device type groups. Note that internally to NCS, DeviceGroups are type of "Group", and thus all children will be of the generic type "subGroup".

## Resource URL

/webacs/api/v1/data/DeviceGroups

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
int | clearedAlarms | Number of cleared alarms against members of the group.
int | criticalAlarms | Number of critical alarms against members of the group.
long | groupId | The internal id of this group.
String | groupName | The instance name of this group.
int | informationAlarms | Number of informational alarms against members of the group.
int | majorAlarms | Number of major alarms against members of the group.
int | minorAlarms | Number of minor alarms against members of the group.
String | name | The hierarchical name of the group.
int | warningAlarms | Number of warning alarms against members of the group.

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://192.168.116.207/webacs/api/v1/data/DeviceGroups/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/DeviceGroups/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="deviceGroupsDTO_$$_javassist_5196">
            <deviceGroupsDTO id="15" displayName="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>
            </deviceGroupsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/DeviceGroups/42.json

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/DeviceGroups\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "deviceGroupsDTO_$$_javassist_5196",
          "deviceGroupsDTO" : {
            "@id" : "15",
            "@displayName" : "String value",
            "clearedAlarms" : 1,
            "criticalAlarms" : 1,
            "groupId" : 2,
            "groupName" : "String value",
            "informationAlarms" : 1,
            "majorAlarms" : 1,
            "minorAlarms" : 1,
            "name" : "String value",
            "warningAlarms" : 1
          }
        }
      }
    }