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 Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v2/data/DeviceGroups UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description |
---|---|
clearedAlarms int |
Number of cleared alarms against members of the group. |
criticalAlarms int |
Number of critical alarms against members of the group. |
groupId long |
The internal id of this group. |
groupName String |
The instance name of this group. |
informationAlarms int |
Number of informational alarms against members of the group. |
majorAlarms int |
Number of major alarms against members of the group. |
minorAlarms int |
Number of minor alarms against members of the group. |
name String |
The hierarchical name of the group. |
warningAlarms int |
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://localhost/webacs/api/v2/data/DeviceGroups/15
<?xml version="1.0" ?>
<queryResponse type="DeviceGroups" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/DeviceGroups/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="deviceGroupsDTO" type="DeviceGroups" url="https://localhost/webacs/api/v2/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://localhost/webacs/api/v2/data/DeviceGroups/15.json
{
"queryResponse" : {
"@type" : "DeviceGroups",
"@requestUrl" : "https://localhost/webacs/api/v2/data/DeviceGroups/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "deviceGroupsDTO",
"@type" : "DeviceGroups",
"@url" : "https://localhost/webacs/api/v2/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
}
} ]
}
}