Remove list of devices from a group (devices are listed by device IDs or IPs). Only Location and 'User Defined' Device groups are supported.
Since Product Version: 3.0
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
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/op/groups/removeDevices
Request Parameters
groupId
Long
|
query
|
RequiredId of the group. Either groupId or groupPath must be specified.
|
groupPath
String
|
query
|
RequiredFull path and name of the group. Either groupId or groupPath must be specified.
|
Request Payload Parameters
deviceIds
Long[]
|
|
deviceIps
String[]
|
List of device IP addresses
|
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 Request Payload
https://localhost/webacs/api/v1/op/groups/removeDevices?groupPath=Location/All Locations/groupName
<?xml version="1.0" ?>
<groupDevicesDTO>
<deviceIds>
<deviceId>15</deviceId>
</deviceIds>
<deviceIps>
<deviceIp>String value</deviceIp>
</deviceIps>
</groupDevicesDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/groups/removeDevices.json?groupPath=Location/All Locations/groupName
{
"groupDevicesDTO" : {
"deviceIds" : {
"deviceId" : 15
},
"deviceIps" : {
"deviceIp" : "String value"
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/groups/removeDevices
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
groupId
Long
|
query
|
RequiredId of the group. Either groupId or groupPath must be specified.
|
groupPath
String
|
query
|
RequiredFull path and name of the group. Either groupId or groupPath must be specified.
|
Request Payload Parameters
deviceIds
Long[]
|
|
deviceIps
String[]
|
List of device IP addresses
|
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 Request Payload
https://localhost/webacs/api/v2/op/groups/removeDevices?groupPath=Location/All Locations/groupName
<?xml version="1.0" ?>
<groupDevicesDTO>
<deviceIds>
<deviceId>15</deviceId>
</deviceIds>
<deviceIps>
<deviceIp>String value</deviceIp>
</deviceIps>
</groupDevicesDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/groups/removeDevices.json?groupPath=Location/All Locations/groupName
{
"groupDevicesDTO" : {
"deviceIds" : {
"deviceId" : [ 15 ]
},
"deviceIps" : {
"deviceIp" : [ "String value" ]
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/groups/removeDevices
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
groupId
Long
|
query
|
RequiredId of the group. Either groupId or groupPath must be specified.
|
groupPath
String
|
query
|
RequiredFull path and name of the group. Either groupId or groupPath must be specified.
|
Request Payload Parameters
deviceIds
Long[]
|
|
deviceIps
String[]
|
List of device IP addresses
|
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 Request Payload
https://localhost/webacs/api/v3/op/groups/removeDevices?groupPath=Location/All Locations/groupName
<?xml version="1.0" ?>
<groupDevicesDTO>
<deviceIds>
<deviceId>15</deviceId>
<deviceId>25</deviceId>
</deviceIds>
<deviceIps>
<deviceIp>String value</deviceIp>
<deviceIp>Another string value</deviceIp>
</deviceIps>
</groupDevicesDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/groups/removeDevices.json?groupPath=Location/All Locations/groupName
{
"groupDevicesDTO" : {
"deviceIds" : {
"deviceId" : [ 15, 25 ]
},
"deviceIps" : {
"deviceIp" : [ "String value", "Another string value" ]
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/groups/removeDevices
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
groupId
Long
|
query
|
RequiredId of the group. Either groupId or groupPath must be specified.
|
groupPath
String
|
query
|
RequiredFull path and name of the group. Either groupId or groupPath must be specified.
|
Request Payload Parameters
deviceIds
Long[]
|
|
deviceIps
String[]
|
List of device IP addresses
|
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 Request Payload
https://localhost/webacs/api/v4/op/groups/removeDevices?groupPath=Location/All Locations/groupName
<?xml version="1.0" ?>
<groupDevicesDTO>
<deviceIds>
<deviceId>15</deviceId>
<deviceId>25</deviceId>
</deviceIds>
<deviceIps>
<deviceIp>String value</deviceIp>
<deviceIp>Another string value</deviceIp>
</deviceIps>
</groupDevicesDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/groups/removeDevices.json?groupPath=Location/All Locations/groupName
{
"groupDevicesDTO" : {
"deviceIds" : {
"deviceId" : [ 15, 25 ]
},
"deviceIps" : {
"deviceIp" : [ "String value", "Another string value" ]
}
}
}