Provides a view of group specific information of devices. Use this service to query or navigate groups
Since Product Version: 2.2
Resource URL
/webacs/api/v1/data/GroupSpecificationResponse Parameters
Type | Attribute Name | Description |
---|---|---|
String |
description |
The description of the group |
String |
groupName |
The name of the group |
String |
groupPath |
The full hierarchy path of the group |
String |
instanceUuid |
This is a uuid for this instance. |
long |
parentId |
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://172.25.123.114/webacs/api/v1/data/GroupSpecification/15
<?xml version="1.0" ?> <queryResponse type="GroupSpecification" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/GroupSpecification/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="groupSpecificationDTO" type="GroupSpecification" url="https://172.25.123.114/webacs/api/v1/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://172.25.123.114/webacs/api/v1/data/GroupSpecification/15.json
{ "queryResponse" : { "@type" : "GroupSpecification", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/GroupSpecification\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "groupSpecificationDTO", "@type" : "GroupSpecification", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/GroupSpecification\/15", "groupSpecificationDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "description" : "String value", "groupName" : "String value", "groupPath" : "String value", "parentId" : 2 } } } }