
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT groups/group

Create or update a device or port group. Only Location and User Defined Device groups and User Defined port groups are supported. You cannot modify the system defined groups except 'Location/All Locations/System Campus' for which you can change only description and geographical location.

Since Product Version: 3.0

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | PUT

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/op/groups/group

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Optional ID of the 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). Optional. Max length of the description is 255 characters.
name String | Required Name of a group. The group name can contain any characters except: '&<>"/? The maximum name length is 255 characters for user-defined groups and location groups with the default type. For location groups with a non-default type, the maximum name length is 40 characters.
path String | Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") relative to the 'User Defined' or 'Location/All Locations' group.
type GroupTypeEnum | Required Type of a group. Allowed values LOCATION USERDEFINED INTERFACEGROUP

## 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://172.20.127.108/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.20.127.108/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.20.127.108/webacs/api/v1/op/groups/group

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
      <groupUpdateResult>
        <action>String value</action>
        <groupId>2</groupId>
      </groupUpdateResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v1/op/groups/group.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/groups\/group",
        "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
        "groupUpdateResult" : {
          "action" : "String value",
          "groupId" : 2
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v2/op/groups/group

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Optional ID of the 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). Optional. Max length of the description is 255 characters.
name String | Required Name of a group. The group name can contain any characters except: '&<>"/? The maximum name length is 255 characters for user-defined groups and location groups with the default type. For location groups with a non-default type, the maximum name length is 40 characters.
path String | Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") relative to the 'User Defined' or 'Location/All Locations' group.
type GroupTypeEnum | Required Type of a group. Allowed values LOCATION USERDEFINED INTERFACEGROUP

## 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://172.20.127.108/webacs/api/v2/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.20.127.108/webacs/api/v2/op/groups/group.json

    {
      "groupPropertiesDTO" : {
        "description" : "String value",
        "name" : "String value",
        "path" : "String value",
        "type" : "LOCATION"
      }
    }

### Sample XML Response Payload

https://172.20.127.108/webacs/api/v2/op/groups/group

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
      <groupUpdateResult>
        <action>String value</action>
        <groupId>2</groupId>
      </groupUpdateResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v2/op/groups/group.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
        "groupUpdateResult" : [ {
          "action" : "String value",
          "groupId" : 2
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v3/op/groups/group

Updated

Since v3 this API allows configuring location parameters for location groups.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Optional Group 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). Optional. Max length of the description is 255 characters.
latitude Float | Latitude of GPS location, measured in degrees. Latitude must range from -90 to 90. Optional. Could be specified only for LOCATION groups. Note that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified.
locationAddress String | Address of location. Optional. Could be specified only for LOCATION groups. Note that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified.
locationGroupType LocationGroupTypeEnum | Type of location. Optional. Could be specified only for LOCATION groups. Note that Default and Campus groups can be created only under a group with Default location type, Building and Outdoor Area groups can be created only under a Campus group, and Floor Area groups can be created only under a Building group. When you are editing a location group, you can change the group type to Campus, if the group type is Default and the group does not have any subgroups. In all other cases it is not allowed to change the location type of the group. Allowed values DEFAULT CAMPUS BUILDING FLOORAREA OUTDOORAREA
longitude Float | Longitude of GPS location, measured in degrees. Longitude must range from -180 to 180. Optional. Could be specified only for LOCATION groups. Note that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified.
name String | Required Name of a group. The group name can contain any characters except: '&<>"/? The maximum name length is 255 characters for user-defined groups and location groups with the default type. For location groups with a non-default type, the maximum name length is 40 characters.
path String | Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") relative to the 'User Defined' or 'Location/All Locations' group.
type GroupTypeEnum | Required Type of a group. Allowed values LOCATION USERDEFINED INTERFACEGROUP

## 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://172.20.127.108/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://172.20.127.108/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://172.20.127.108/webacs/api/v3/op/groups/group

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/op">
      <groupUpdateResult>
        <action>String value</action>
        <groupId>2</groupId>
      </groupUpdateResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v3/op/groups/group.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
        "groupUpdateResult" : [ {
          "action" : "String value",
          "groupId" : 2
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v4/op/groups/group

Unmodified

This resource has not been modified since the previous API version.

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Optional Group 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). Optional. Max length of the description is 255 characters.
latitude Float | Latitude of GPS location, measured in degrees. Latitude must range from -90 to 90. Optional. Could be specified only for LOCATION groups. Note that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified.
locationAddress String | Address of location. Optional. Could be specified only for LOCATION groups. Note that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified.
locationGroupType LocationGroupTypeEnum | Type of location. Optional. Could be specified only for LOCATION groups. Note that Default and Campus groups can be created only under a group with Default location type, Building and Outdoor Area groups can be created only under a Campus group, and Floor Area groups can be created only under a Building group. When you are editing a location group, you can change the group type to Campus, if the group type is Default and the group does not have any subgroups. In all other cases it is not allowed to change the location type of the group. Allowed values DEFAULT CAMPUS BUILDING FLOORAREA OUTDOORAREA
longitude Float | Longitude of GPS location, measured in degrees. Longitude must range from -180 to 180. Optional. Could be specified only for LOCATION groups. Note that locationAddress, longitude, and latitude attributes must be specified all together or none of them must be specified.
name String | Required Name of a group. The group name can contain any characters except: '&<>"/? The maximum name length is 255 characters for user-defined groups and location groups with the default type. For location groups with a non-default type, the maximum name length is 40 characters.
path String | Path to the group (slash-separated, e.g. "group/subgroup/sub_subgroup") relative to the 'User Defined' or 'Location/All Locations' group.
type GroupTypeEnum | Required Type of a group. Allowed values LOCATION USERDEFINED INTERFACEGROUP

## 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://172.20.127.108/webacs/api/v4/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://172.20.127.108/webacs/api/v4/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://172.20.127.108/webacs/api/v4/op/groups/group

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/op">
      <groupUpdateResult>
        <action>String value</action>
        <groupId>2</groupId>
      </groupUpdateResult>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v4/op/groups/group.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
        "groupUpdateResult" : [ {
          "action" : "String value",
          "groupId" : 2
        } ]
      }
    }