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

# PUT groups/groupRules

Replace set of group rules with a new one. Only Location and Network Device groups are supported.

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/groupRules

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Required Id of the group. Either groupId or groupPath must be specified.
groupPath String | query | Required Full path and name of the group. Either groupId or groupPath must be specified.

## Request Payload Parameters

Attribute | Description
--- | ---
rules GroupDeviceRule[] | Required List of group rules
Attribute | Description
--- | ---
criteria String | Required Argument for the conditional operation.
field String | Required Field of Device to apply the conditional operation. Allowed values for location groups: "City", "City Division", "Country", "County", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Postal Code", "Serial Number", "State". Allowed values for user defined groups: "Contact", "Description(sysDescr)", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Product Family", "Product Series", "Product Type", "Software Type", "Software Version". To add dynamic rule on a user defined field pass the field name with the "UDF:" prefix.
matchCondition MatchConditionEnum | Required Logical operator to chain multiple rules together. Allowed values AND OR
operation GroupDeviceRuleOperationEnum | Required Conditional operation to apply to the device field. Allowed values IS_EMPTY IS_NOT_EMPTY IS_TRUE IS_FALSE CONTAINS NOT_CONTAINS EQUALS NOT_EQUALS STARTS_WITH ENDS_WITH GREATER_THAN LESS_THAN GREATER_EQUALS LESS_EQUALS IN_RANGE MATCHES NOT_MATCHES

## 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://10.64.88.203/webacs/api/v1/op/groups/groupRules?groupPath=Location/All Locations/groupName

    <?xml version="1.0" ?>
    <groupRulesDTO>
      <rules>
        <rule>
          <criteria>String value</criteria>
          <field>String value</field>
          <matchCondition>AND</matchCondition>
          <operation>IS_EMPTY</operation>
        </rule>
        <rule>
          <criteria>Another string value</criteria>
          <field>Another string value</field>
          <matchCondition>OR</matchCondition>
          <operation>IS_NOT_EMPTY</operation>
        </rule>
      </rules>
    </groupRulesDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/groups/groupRules.json?groupPath=Location/All Locations/groupName

    {
      "groupRulesDTO" : {
        "rules" : {
          "rule" : [{
            "criteria" : "String value",
            "field" : "String value",
            "matchCondition" : "AND",
            "operation" : "IS_EMPTY"
          },
          {
            "criteria" : "Another string value",
            "field" : "Another string value",
            "matchCondition" : "OR",
            "operation" : "IS_NOT_EMPTY"
          }]
        }
      }
    }

### 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/groupRules

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Required Id of the group. Either groupId or groupPath must be specified.
groupPath String | query | Required Full path and name of the group. Either groupId or groupPath must be specified.

## Request Payload Parameters

Attribute | Description
--- | ---
rules GroupDeviceRule[] | Required List of group rules
Attribute | Description
--- | ---
criteria String | Required Argument for the conditional operation.
field String | Required Field of Device to apply the conditional operation. Allowed values for location groups: "City", "City Division", "Country", "County", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Postal Code", "Serial Number", "State". Allowed values for user defined groups: "Contact", "Description(sysDescr)", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Product Family", "Product Series", "Product Type", "Software Type", "Software Version". To add dynamic rule on a user defined field pass the field name with the "UDF:" prefix.
matchCondition MatchConditionEnum | Required Logical operator to chain multiple rules together. Allowed values AND OR
operation GroupDeviceRuleOperationEnum | Required Conditional operation to apply to the device field. Allowed values IS_EMPTY IS_NOT_EMPTY IS_TRUE IS_FALSE CONTAINS NOT_CONTAINS EQUALS NOT_EQUALS STARTS_WITH ENDS_WITH GREATER_THAN LESS_THAN GREATER_EQUALS LESS_EQUALS IN_RANGE MATCHES NOT_MATCHES

## 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://10.64.88.203/webacs/api/v2/op/groups/groupRules?groupPath=Location/All Locations/groupName

    <?xml version="1.0" ?>
    <groupRulesDTO>
      <rules>
        <rule>
          <criteria>String value</criteria>
          <field>String value</field>
          <matchCondition>AND</matchCondition>
          <operation>IS_EMPTY</operation>
        </rule>
        <rule>
          <criteria>Another string value</criteria>
          <field>Another string value</field>
          <matchCondition>OR</matchCondition>
          <operation>IS_NOT_EMPTY</operation>
        </rule>
      </rules>
    </groupRulesDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/groups/groupRules.json?groupPath=Location/All Locations/groupName

    {
      "groupRulesDTO" : {
        "rules" : {
          "rule" : [ {
            "criteria" : "String value",
            "field" : "String value",
            "matchCondition" : "AND",
            "operation" : "IS_EMPTY"
          }, {
            "criteria" : "Another string value",
            "field" : "Another string value",
            "matchCondition" : "OR",
            "operation" : "IS_NOT_EMPTY"
          } ]
        }
      }
    }

### 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/groupRules

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Required Id of the group. Either groupId or groupPath must be specified.
groupPath String | query | Required Full path and name of the group. Either groupId or groupPath must be specified.

## Request Payload Parameters

Attribute | Description
--- | ---
rules GroupDeviceRule[] | Required List of group rules
Attribute | Description
--- | ---
criteria String | Required Argument for the conditional operation.
field String | Required Field of Device to apply the conditional operation. Allowed values for location groups: "City", "City Division", "Country", "County", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Postal Code", "Serial Number", "State". Allowed values for user defined groups: "Contact", "Description(sysDescr)", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Product Family", "Product Series", "Product Type", "Software Type", "Software Version". To add dynamic rule on a user defined field pass the field name with the "UDF:" prefix.
matchCondition MatchConditionEnum | Required Logical operator to chain multiple rules together. Allowed values AND OR
operation GroupDeviceRuleOperationEnum | Required Conditional operation to apply to the device field. Allowed values IS_EMPTY IS_NOT_EMPTY IS_TRUE IS_FALSE CONTAINS NOT_CONTAINS EQUALS NOT_EQUALS STARTS_WITH ENDS_WITH GREATER_THAN LESS_THAN GREATER_EQUALS LESS_EQUALS IN_RANGE MATCHES NOT_MATCHES

## 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://10.64.88.203/webacs/api/v3/op/groups/groupRules?groupPath=Location/All Locations/groupName

    <?xml version="1.0" ?>
    <groupRulesDTO>
      <rules>
        <rule>
          <criteria>String value</criteria>
          <field>String value</field>
          <matchCondition>AND</matchCondition>
          <operation>IS_EMPTY</operation>
        </rule>
        <rule>
          <criteria>Another string value</criteria>
          <field>Another string value</field>
          <matchCondition>OR</matchCondition>
          <operation>IS_NOT_EMPTY</operation>
        </rule>
      </rules>
    </groupRulesDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/groups/groupRules.json?groupPath=Location/All Locations/groupName

    {
      "groupRulesDTO" : {
        "rules" : {
          "rule" : [ {
            "criteria" : "String value",
            "field" : "String value",
            "matchCondition" : "AND",
            "operation" : "IS_EMPTY"
          }, {
            "criteria" : "Another string value",
            "field" : "Another string value",
            "matchCondition" : "OR",
            "operation" : "IS_NOT_EMPTY"
          } ]
        }
      }
    }

### 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/groupRules

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
groupId Long | query | Required Id of the group. Either groupId or groupPath must be specified.
groupPath String | query | Required Full path and name of the group. Either groupId or groupPath must be specified.

## Request Payload Parameters

Attribute | Description
--- | ---
rules GroupDeviceRule[] | Required List of group rules
Attribute | Description
--- | ---
criteria String | Required Argument for the conditional operation.
field String | Required Field of Device to apply the conditional operation. Allowed values for location groups: "City", "City Division", "Country", "County", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Postal Code", "Serial Number", "State". Allowed values for user defined groups: "Contact", "Description(sysDescr)", "Device Name", "DNS Name", "Location(sysLocation)", "Management Address", "Module Name", "Module Part Number", "Product Family", "Product Series", "Product Type", "Software Type", "Software Version". To add dynamic rule on a user defined field pass the field name with the "UDF:" prefix.
matchCondition MatchConditionEnum | Required Logical operator to chain multiple rules together. Allowed values AND OR
operation GroupDeviceRuleOperationEnum | Required Conditional operation to apply to the device field. Allowed values IS_EMPTY IS_NOT_EMPTY IS_TRUE IS_FALSE CONTAINS NOT_CONTAINS EQUALS NOT_EQUALS STARTS_WITH ENDS_WITH GREATER_THAN LESS_THAN GREATER_EQUALS LESS_EQUALS IN_RANGE MATCHES NOT_MATCHES

## 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://10.64.88.203/webacs/api/v4/op/groups/groupRules?groupPath=Location/All Locations/groupName

    <?xml version="1.0" ?>
    <groupRulesDTO>
      <rules>
        <rule>
          <criteria>String value</criteria>
          <field>String value</field>
          <matchCondition>AND</matchCondition>
          <operation>IS_EMPTY</operation>
        </rule>
        <rule>
          <criteria>Another string value</criteria>
          <field>Another string value</field>
          <matchCondition>OR</matchCondition>
          <operation>IS_NOT_EMPTY</operation>
        </rule>
      </rules>
    </groupRulesDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/groups/groupRules.json?groupPath=Location/All Locations/groupName

    {
      "groupRulesDTO" : {
        "rules" : {
          "rule" : [ {
            "criteria" : "String value",
            "field" : "String value",
            "matchCondition" : "AND",
            "operation" : "IS_EMPTY"
          }, {
            "criteria" : "Another string value",
            "field" : "Another string value",
            "matchCondition" : "OR",
            "operation" : "IS_NOT_EMPTY"
          } ]
        }
      }
    }