Statically assign list of devices to a group (devices are listed by device IDs or IP addresses). Only Location and User Defined device groups are supported.
Since Product Version: 3.0
Resource Information
|
Rate Limiting? |
No |
|
Sorting? |
No |
|
Paging? |
No |
|
Filtering? |
No |
|
Group Filtering? |
No |
|
Aggregation? |
No |
|
Response Formats |
xml json |
|
User Group |
NBI Write |
|
HTTP Methods |
PUT |
Resource URL
/webacs/api/v3/op/groups/groupDevices UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
| Attribute | Source | Description |
|---|---|---|
|
groupId Long |
query |
Required Id of the group. Either groupId or groupPath must be specified. |
|
groupPath String |
query |
Required Full path and name of the group. Either groupId or groupPath must be specified. |
Request Payload Parameters
| Attribute | Description |
|---|---|
|
deviceIds Long[] |
List of device IDs |
|
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/groupDevices?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/groupDevices.json?groupPath=Location/All Locations/groupName
{
"groupDevicesDTO" : {
"deviceIds" : {
"deviceId" : [ 15, 25 ]
},
"deviceIps" : {
"deviceIp" : [ "String value", "Another string value" ]
}
}
}