Provides a view of group specific information of devices. Use this service to query or navigate groups
Since Product Version: 2.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v3/data/GroupSpecification UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description |
---|---|
description String |
The description of the group |
groupName String |
The name of the group |
groupPath String |
The full hierarchy path of the group |
parentId long |
The parent group id of the group. If it is -1, it is a root group. There are three root groups: User Defined, Device Type, Location |
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/v3/data/GroupSpecification/15
<?xml version="1.0" ?>
<queryResponse type="GroupSpecification" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/GroupSpecification/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="groupSpecificationDTO" type="GroupSpecification" url="https://localhost/webacs/api/v3/data/GroupSpecification/15">
<groupSpecificationDTO displayName="String value" id="15" uuid="String value">
<description>String value</description>
<groupName>String value</groupName>
<groupPath>String value</groupPath>
<parentId>2</parentId>
</groupSpecificationDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/GroupSpecification/15.json
{
"queryResponse" : {
"@type" : "GroupSpecification",
"@requestUrl" : "https://localhost/webacs/api/v3/data/GroupSpecification/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "groupSpecificationDTO",
"@type" : "GroupSpecification",
"@url" : "https://localhost/webacs/api/v3/data/GroupSpecification/15",
"groupSpecificationDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"groupName" : "String value",
"groupPath" : "String value",
"parentId" : 2
}
} ]
}
}