Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET VDAssociatedGroups

Represents a Location or User Defined group explicitly assigned to a current virtual domain.

Since Product Version: 3.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v1/data/VDAssociatedGroups

Response Parameters

Attribute Description

displayName String

This is the displayName for this instance.

hierarchyName String

Dynamic Group hierarchical name

instanceUuid String

This is a uuid for this instance.

name String

Dynamic Group name

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://localhost/webacs/api/v1/data/VDAssociatedGroups/15

<?xml version="1.0" ?>
<queryResponse type="VDAssociatedGroups" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/VDAssociatedGroups/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="vDAssociatedGroupsDTO" type="VDAssociatedGroups" url="https://localhost/webacs/api/v1/data/VDAssociatedGroups/15">
    <vdAssociatedGroupsDTO displayName="String value" id="15" uuid="String value">
      <hierarchyName>String value</hierarchyName>
      <name>String value</name>
    </vdAssociatedGroupsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v1/data/VDAssociatedGroups/15.json

{
  "queryResponse" : {
    "@type" : "VDAssociatedGroups",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedGroups\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "vDAssociatedGroupsDTO",
      "@type" : "VDAssociatedGroups",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedGroups\/15",
      "vdAssociatedGroupsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "hierarchyName" : "String value",
        "name" : "String value"
      }
    }
  }
}