Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET VDAssociatedSiteMaps

Represents a Site Map associated with a virtual domain.

Since Product Version: 3.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v3/data/VDAssociatedSiteMaps

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

This resource has not been modified since the previous API version.

Response Parameters

Attribute Description

hierarchyName String

Site Map hierarchical name

name String

Site Map name

parentId Long

Site Map parent Id

type int

Site Map Type: 1 Campus, 2 Building, 4 Floor Area, 5 Outdoor Area

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/v3/data/VDAssociatedSiteMaps/15

<?xml version="1.0" ?>
<queryResponse type="VDAssociatedSiteMaps" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/VDAssociatedSiteMaps/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="vDAssociatedSiteMapsDTO" type="VDAssociatedSiteMaps" url="https://localhost/webacs/api/v3/data/VDAssociatedSiteMaps/15">
    <vdAssociatedSiteMapsDTO displayName="String value" id="15" uuid="String value">
      <hierarchyName>String value</hierarchyName>
      <name>String value</name>
      <parentId>15</parentId>
      <type>1</type>
    </vdAssociatedSiteMapsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/VDAssociatedSiteMaps/15.json

{
  "queryResponse" : {
    "@type" : "VDAssociatedSiteMaps",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/VDAssociatedSiteMaps/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "vDAssociatedSiteMapsDTO",
      "@type" : "VDAssociatedSiteMaps",
      "@url" : "https://localhost/webacs/api/v3/data/VDAssociatedSiteMaps/15",
      "vdAssociatedSiteMapsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "hierarchyName" : "String value",
        "name" : "String value",
        "parentId" : 15,
        "type" : 1
      }
    } ]
  }
}