Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET groups/groupRules

Get list of group rules. Only Location and Network Device groups are supported.

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 Read

HTTP Methods

GET

DevNet Discussions

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

RequiredId of the group. Either groupId or groupPath must be specified.

groupPath String

query

RequiredFull path and name of the group. Either groupId or groupPath must be specified.

Response Parameters

Attribute Description

rules GroupDeviceRule[]

List of group rules

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 Response Payload

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

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/groups/groupRules?groupPath=Location/All Locations/groupName" rootUrl="https://localhost/webacs/api/v3/op">
  <groupRulesDTO>
    <rules>
      <rule>
        <criteria>String value</criteria>
        <field>String value</field>
        <matchCondition>AND</matchCondition>
        <operation>IS_EMPTY</operation>
      </rule>
      <rule>
        <criteria>String value</criteria>
        <field>String value</field>
        <matchCondition>AND</matchCondition>
        <operation>IS_EMPTY</operation>
      </rule>
    </rules>
  </groupRulesDTO>
</mgmtResponse>

Sample JSON Response Payload

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

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v3/op/groups/groupRules?groupPath=Location/All Locations/groupName",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v3/op",
    "groupRulesDTO" : [ {
      "rules" : {
        "rule" : [ {
          "criteria" : "String value",
          "field" : "String value",
          "matchCondition" : "AND",
          "operation" : "IS_EMPTY"
        }, {
          "criteria" : "String value",
          "field" : "String value",
          "matchCondition" : "AND",
          "operation" : "IS_EMPTY"
        } ]
      }
    } ]
  }
}