Represents a Network Device 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/VDAssociatedDevices
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
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available
|
name
String
|
|
type
String
|
|
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/VDAssociatedDevices/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedDevices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/VDAssociatedDevices/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="vDAssociatedDevicesDTO" type="VDAssociatedDevices" url="https://localhost/webacs/api/v1/data/VDAssociatedDevices/15">
<vdAssociatedDevicesDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ipAddress>String value</ipAddress>
<name>String value</name>
<type>String value</type>
</vdAssociatedDevicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/VDAssociatedDevices/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedDevices",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedDevices\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "vDAssociatedDevicesDTO",
"@type" : "VDAssociatedDevices",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedDevices\/15",
"vdAssociatedDevicesDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"type" : "String value"
}
}
}
}
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/VDAssociatedDevices
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
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available
|
name
String
|
|
type
String
|
|
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/VDAssociatedDevices/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedDevices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/VDAssociatedDevices/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="vDAssociatedDevicesDTO" type="VDAssociatedDevices" url="https://localhost/webacs/api/v2/data/VDAssociatedDevices/15">
<vdAssociatedDevicesDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ipAddress>String value</ipAddress>
<name>String value</name>
<type>String value</type>
</vdAssociatedDevicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/VDAssociatedDevices/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedDevices",
"@requestUrl" : "https://localhost/webacs/api/v2/data/VDAssociatedDevices/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "vDAssociatedDevicesDTO",
"@type" : "VDAssociatedDevices",
"@url" : "https://localhost/webacs/api/v2/data/VDAssociatedDevices/15",
"vdAssociatedDevicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"type" : "String value"
}
} ]
}
}
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/VDAssociatedDevices
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
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available
|
name
String
|
|
type
String
|
|
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/VDAssociatedDevices/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedDevices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/VDAssociatedDevices/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="vDAssociatedDevicesDTO" type="VDAssociatedDevices" url="https://localhost/webacs/api/v3/data/VDAssociatedDevices/15">
<vdAssociatedDevicesDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ipAddress>String value</ipAddress>
<name>String value</name>
<type>String value</type>
</vdAssociatedDevicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/VDAssociatedDevices/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedDevices",
"@requestUrl" : "https://localhost/webacs/api/v3/data/VDAssociatedDevices/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "vDAssociatedDevicesDTO",
"@type" : "VDAssociatedDevices",
"@url" : "https://localhost/webacs/api/v3/data/VDAssociatedDevices/15",
"vdAssociatedDevicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"type" : "String value"
}
} ]
}
}
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/VDAssociatedDevices
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
instanceOrigin
InstanceOriginEnum
|
Allowed values:
- UNCONCERNED
- APPLICATION
- NETWORK
|
instanceTenantId
Integer
|
This is a tenant id for this instance.
|
ipAddress
String
|
The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available
|
name
String
|
|
type
String
|
|
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/VDAssociatedDevices/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedDevices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/VDAssociatedDevices/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="vDAssociatedDevicesDTO" type="VDAssociatedDevices" url="https://localhost/webacs/api/v4/data/VDAssociatedDevices/15">
<vdAssociatedDevicesDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<ipAddress>String value</ipAddress>
<name>String value</name>
<type>String value</type>
</vdAssociatedDevicesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/VDAssociatedDevices/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedDevices",
"@requestUrl" : "https://localhost/webacs/api/v4/data/VDAssociatedDevices/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "vDAssociatedDevicesDTO",
"@type" : "VDAssociatedDevices",
"@url" : "https://localhost/webacs/api/v4/data/VDAssociatedDevices/15",
"vdAssociatedDevicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"type" : "String value"
}
} ]
}
}