Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_UserDefinedGroups

# GET UserDefinedGroups

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

Provides the list of User Defined groups and the associated sub group hierarchy. Note that internally to NCS, UserDefinedGroups are type of "Group", and thus all children will be of the generic type "subGroup".

## Resource URL

/webacs/api/v1/data/UserDefinedGroups

Since : 1.2

## 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.
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 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/UserDefinedGroups/42

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

## Sample JSON Payload

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

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/UserDefinedGroups\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "userDefinedGroupsDTO_$$_javassist_5200",
          "userDefinedGroupsDTO" : {
            "@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
          }
        }
      }
    }