Do not use this resource. Replaced by /op/groups/deviceGroups.
This provides information about the hierarchy of device type groups. Note that internally, DeviceGroups are type of "Group", and thus all children will be of the generic type "subGroup".
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/DeviceGroupsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
int |
clearedAlarms |
Number of cleared alarms against members of the group. |
int |
criticalAlarms |
Number of critical alarms against members of the group. |
long |
groupId |
The internal id of this group. |
String |
groupName |
The instance name of this group. |
int |
informationAlarms |
Number of informational alarms against members of the group. |
String |
instanceUuid |
This is a uuid for this instance. |
int |
majorAlarms |
Number of major alarms against members of the group. |
int |
minorAlarms |
Number of minor alarms against members of the group. |
String |
name |
The hierarchical name of the group. |
int |
warningAlarms |
Number of warning alarms against members of the group. |
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://172.25.123.114/webacs/api/v1/data/DeviceGroups/15
<?xml version="1.0" ?> <queryResponse type="DeviceGroups" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/DeviceGroups/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="deviceGroupsDTO" type="DeviceGroups" url="https://172.25.123.114/webacs/api/v1/data/DeviceGroups/15"> <deviceGroupsDTO displayName="String value" id="15" uuid="String value"> <clearedAlarms>1</clearedAlarms> <criticalAlarms>1</criticalAlarms> <groupId>2</groupId> <groupName>String value</groupName> <informationAlarms>1</informationAlarms> <majorAlarms>1</majorAlarms> <minorAlarms>1</minorAlarms> <name>String value</name> <warningAlarms>1</warningAlarms> </deviceGroupsDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/DeviceGroups/15.json
{ "queryResponse" : { "@type" : "DeviceGroups", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/DeviceGroups\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "deviceGroupsDTO", "@type" : "DeviceGroups", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/DeviceGroups\/15", "deviceGroupsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "clearedAlarms" : 1, "criticalAlarms" : 1, "groupId" : 2, "groupName" : "String value", "informationAlarms" : 1, "majorAlarms" : 1, "minorAlarms" : 1, "name" : "String value", "warningAlarms" : 1 } } } }