Do not use this resource. Replaced by API User Defined Groups.
Provides the list of User Defined groups and the associated sub group hierarchy. Note that internally, UserDefinedGroups 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/UserDefinedGroups UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description |
---|---|
clearedAlarms int |
Number of cleared alarms registered against devices within this site. |
criticalAlarms int |
Number of critical alarms registered against devices within this site. |
groupId long |
The internal instance id of the user defined group. |
groupName String |
The name of the user defined group |
informationAlarms int |
Number of information alarms registered against devices within this site. |
majorAlarms int |
Number of major alarms registered against devices within this site. |
minorAlarms int |
Number of minor alarms registered against devices within this site. |
name String |
The hierarchical name of the group. |
warningAlarms int |
Number of warning alarms registered against devices within this site. |
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/UserDefinedGroups/15
<?xml version="1.0" ?>
<queryResponse type="UserDefinedGroups" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/UserDefinedGroups/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="userDefinedGroupsDTO" type="UserDefinedGroups" url="https://localhost/webacs/api/v2/data/UserDefinedGroups/15">
<userDefinedGroupsDTO 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>
</userDefinedGroupsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/UserDefinedGroups/15.json
{
"queryResponse" : {
"@type" : "UserDefinedGroups",
"@requestUrl" : "https://localhost/webacs/api/v2/data/UserDefinedGroups/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "userDefinedGroupsDTO",
"@type" : "UserDefinedGroups",
"@url" : "https://localhost/webacs/api/v2/data/UserDefinedGroups/15",
"userDefinedGroupsDTO" : {
"@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
}
} ]
}
}