Create or update a device or port group. Only Location and 'User Defined' Device groups and 'User Defined' port groups are supported. The location parameters (locationGroupType, civicLocation and GPS location) can be defined only for Location group. If a location type isn't specified the type will "Default".
Since Product Version: 3.0
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
DevNet Discussions
Resource URL
/webacs/api/v3/op/groups/group UpdatedSince v3 this API allows configuring location parameters for location groups.
Request Parameters
Attribute | Source | Description |
---|---|---|
groupId Long |
query |
OptionalGroup ID of group to update, if given. If not, new group will be created. |
Request Payload Parameters
Attribute | Description |
---|---|
description String |
Description of a group (human-readable) |
latitude Float |
Latitude of GPS location. Could be specified only for LOCATION groups |
locationAddress String |
Address of location. Could be specified only for LOCATION groups |
locationGroupType LocationGroupTypeEnum |
Type of location. Could be specified only for LOCATION groups Allowed values: |
longitude Float |
Longitude of GPS location. Could be specified only for LOCATION groups |
name String |
Name of a group |
path String |
Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") |
type GroupTypeEnum |
Group type Allowed values: |
Response Parameters
Attribute | Description |
---|---|
action String |
"CREATED" or "UPDATED". Action permitted by operation. |
groupId long |
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://localhost/webacs/api/v3/op/groups/group
<?xml version="1.0" ?>
<groupWithLocationDTO>
<description>String value</description>
<name>String value</name>
<path>String value</path>
<type>LOCATION</type>
<latitude>15.0</latitude>
<locationAddress>String value</locationAddress>
<locationGroupType>DEFAULT</locationGroupType>
<longitude>15.0</longitude>
</groupWithLocationDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/groups/group.json
{
"groupWithLocationDTO" : {
"description" : "String value",
"latitude" : 15.0,
"locationAddress" : "String value",
"locationGroupType" : "DEFAULT",
"longitude" : 15.0,
"name" : "String value",
"path" : "String value",
"type" : "LOCATION"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/groups/group
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/groups/group" rootUrl="https://localhost/webacs/api/v3/op">
<groupUpdateResult>
<action>String value</action>
<groupId>2</groupId>
</groupUpdateResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/groups/group.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/groups/group",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"groupUpdateResult" : [ {
"action" : "String value",
"groupId" : 2
} ]
}
}