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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/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
Response Parameters
hierarchyName
String
|
Site Map hierarchical name
|
name
String
|
|
parentId
Long
|
|
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/v1/data/VDAssociatedSiteMaps/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedSiteMaps" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/VDAssociatedSiteMaps/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="vDAssociatedSiteMapsDTO" type="VDAssociatedSiteMaps" url="https://localhost/webacs/api/v1/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/v1/data/VDAssociatedSiteMaps/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedSiteMaps",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedSiteMaps\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "vDAssociatedSiteMapsDTO",
"@type" : "VDAssociatedSiteMaps",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedSiteMaps\/15",
"vdAssociatedSiteMapsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"hierarchyName" : "String value",
"name" : "String value",
"parentId" : 15,
"type" : 1
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/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
hierarchyName
String
|
Site Map hierarchical name
|
name
String
|
|
parentId
Long
|
|
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/v2/data/VDAssociatedSiteMaps/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedSiteMaps" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/VDAssociatedSiteMaps/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="vDAssociatedSiteMapsDTO" type="VDAssociatedSiteMaps" url="https://localhost/webacs/api/v2/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/v2/data/VDAssociatedSiteMaps/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedSiteMaps",
"@requestUrl" : "https://localhost/webacs/api/v2/data/VDAssociatedSiteMaps/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "vDAssociatedSiteMapsDTO",
"@type" : "VDAssociatedSiteMaps",
"@url" : "https://localhost/webacs/api/v2/data/VDAssociatedSiteMaps/15",
"vdAssociatedSiteMapsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"hierarchyName" : "String value",
"name" : "String value",
"parentId" : 15,
"type" : 1
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
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
hierarchyName
String
|
Site Map hierarchical name
|
name
String
|
|
parentId
Long
|
|
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
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/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
hierarchyName
String
|
Site Map hierarchical name
|
name
String
|
|
parentId
Long
|
|
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/v4/data/VDAssociatedSiteMaps/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedSiteMaps" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/VDAssociatedSiteMaps/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="vDAssociatedSiteMapsDTO" type="VDAssociatedSiteMaps" url="https://localhost/webacs/api/v4/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/v4/data/VDAssociatedSiteMaps/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedSiteMaps",
"@requestUrl" : "https://localhost/webacs/api/v4/data/VDAssociatedSiteMaps/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "vDAssociatedSiteMapsDTO",
"@type" : "VDAssociatedSiteMaps",
"@url" : "https://localhost/webacs/api/v4/data/VDAssociatedSiteMaps/15",
"vdAssociatedSiteMapsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"hierarchyName" : "String value",
"name" : "String value",
"parentId" : 15,
"type" : 1
}
} ]
}
}