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
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/GroupSpecification
Response Parameters
description
String
|
The description of the group
|
groupName
String
|
|
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://10.64.80.159/webacs/api/v1/data/GroupSpecification/15
<?xml version="1.0" ?>
<queryResponse type="GroupSpecification" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v1/data/GroupSpecification/15" rootUrl="https://10.64.80.159/webacs/api/v1/data">
<entity dtoType="groupSpecificationDTO" type="GroupSpecification" url="https://10.64.80.159/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://10.64.80.159/webacs/api/v1/data/GroupSpecification/15.json
{
"queryResponse" : {
"@type" : "GroupSpecification",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/data\/GroupSpecification\/15",
"@rootUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "groupSpecificationDTO",
"@type" : "GroupSpecification",
"@url" : "https : \/\/10.64.80.159\/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
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/GroupSpecification
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
description
String
|
The description of the group
|
groupName
String
|
|
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://10.64.80.159/webacs/api/v2/data/GroupSpecification/15
<?xml version="1.0" ?>
<queryResponse type="GroupSpecification" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v2/data/GroupSpecification/15" rootUrl="https://10.64.80.159/webacs/api/v2/data">
<entity dtoType="groupSpecificationDTO" type="GroupSpecification" url="https://10.64.80.159/webacs/api/v2/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://10.64.80.159/webacs/api/v2/data/GroupSpecification/15.json
{
"queryResponse" : {
"@type" : "GroupSpecification",
"@requestUrl" : "https://10.64.80.159/webacs/api/v2/data/GroupSpecification/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.80.159/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "groupSpecificationDTO",
"@type" : "GroupSpecification",
"@url" : "https://10.64.80.159/webacs/api/v2/data/GroupSpecification/15",
"groupSpecificationDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"groupName" : "String value",
"groupPath" : "String value",
"parentId" : 2
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/GroupSpecification
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
description
String
|
The description of the group
|
groupName
String
|
|
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://10.64.80.159/webacs/api/v3/data/GroupSpecification/15
<?xml version="1.0" ?>
<queryResponse type="GroupSpecification" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v3/data/GroupSpecification/15" rootUrl="https://10.64.80.159/webacs/api/v3/data">
<entity dtoType="groupSpecificationDTO" type="GroupSpecification" url="https://10.64.80.159/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://10.64.80.159/webacs/api/v3/data/GroupSpecification/15.json
{
"queryResponse" : {
"@type" : "GroupSpecification",
"@requestUrl" : "https://10.64.80.159/webacs/api/v3/data/GroupSpecification/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.80.159/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "groupSpecificationDTO",
"@type" : "GroupSpecification",
"@url" : "https://10.64.80.159/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
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/GroupSpecification
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
description
String
|
The description of the group
|
groupName
String
|
|
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://10.64.80.159/webacs/api/v4/data/GroupSpecification/15
<?xml version="1.0" ?>
<queryResponse type="GroupSpecification" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v4/data/GroupSpecification/15" rootUrl="https://10.64.80.159/webacs/api/v4/data">
<entity dtoType="groupSpecificationDTO" type="GroupSpecification" url="https://10.64.80.159/webacs/api/v4/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://10.64.80.159/webacs/api/v4/data/GroupSpecification/15.json
{
"queryResponse" : {
"@type" : "GroupSpecification",
"@requestUrl" : "https://10.64.80.159/webacs/api/v4/data/GroupSpecification/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.80.159/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "groupSpecificationDTO",
"@type" : "GroupSpecification",
"@url" : "https://10.64.80.159/webacs/api/v4/data/GroupSpecification/15",
"groupSpecificationDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"groupName" : "String value",
"groupPath" : "String value",
"parentId" : 2
}
} ]
}
}