Create or update a device or port group. Only Location and 'User Defined' Device groups and 'User Defined' port groups are supported.
Since Product Version: 3.0
Resource URL
/webacs/api/v1/op/groups/groupRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
Long |
groupId optional |
query |
Group ID of group to update, if given. If not, new group will be created. |
Request Payload Parameters
Type | Attribute Name | Description |
---|---|---|
String |
description |
Description of a group (human-readable) |
String |
name |
Name of a group |
String |
path |
Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") |
GroupTypeEnum |
type |
Allowed values:
|
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
action |
"CREATED" or "UPDATED". Action permitted by operation. |
long |
groupId |
Group ID of updated or created 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 Request Payload
https://172.25.123.114/webacs/api/v1/op/groups/group
<?xml version="1.0" ?> <groupPropertiesDTO> <description>String value</description> <name>String value</name> <path>String value</path> <type>LOCATION</type> </groupPropertiesDTO>
Sample JSON Request Payload
https://172.25.123.114/webacs/api/v1/op/groups/group.json
{ "groupPropertiesDTO" : { "description" : "String value", "name" : "String value", "path" : "String value", "type" : "LOCATION" } }
Sample XML Response Payload
https://172.25.123.114/webacs/api/v1/op/groups/group
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <groupUpdateResult> <action>String value</action> <groupId>2</groupId> </groupUpdateResult> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/groups/group.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/groups\/group", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "groupUpdateResult" : { "action" : "String value", "groupId" : 2 } } }