Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET GroupSpecification

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Provides a view of group specific information of devices. Use this service to query or navigate groups

Resource URL

/webacs/api/v1/data/GroupSpecification

Since : 2.2

Response Parameters

Type Attribute Name Description

String

description

The description of the group

String

groupName

The name of the group

String

groupPath

The full hierarchy path of the group

long

parentId

The parent group id of the group. If it is -1, it is a root group. There are three root groups: User Defined, Device Type, Site Groups

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://szier-m8-106.cisco.com/webacs/api/v1/data/GroupSpecification/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/data" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/data/GroupSpecification/42" responseType="getEntity">
    <entity url="https://szier-m8-106.cisco.com/webacs/api/v1/data/GroupSpecification/15" type="GroupSpecification" dtoType="groupSpecificationDTO">
        <groupSpecificationDTO id="15" displayName="String value">
            <description>String value</description>
            <groupName>String value</groupName>
            <groupPath>String value</groupPath>
            <parentId>2</parentId>
        </groupSpecificationDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://szier-m8-106.cisco.com/webacs/api/v1/data/GroupSpecification/42.json

{
  "queryResponse" : {
    "@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/data",
    "@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/data\/GroupSpecification\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/data\/GroupSpecification\/15",
      "@type" : "GroupSpecification",
      "@dtoType" : "groupSpecificationDTO",
      "groupSpecificationDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "description" : "String value",
        "groupName" : "String value",
        "groupPath" : "String value",
        "parentId" : 2
      }
    }
  }
}