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

# GET settings/data/pruneDataConfigsByGroup/{category}

Retrieves data pruning configurations for given category.

Since Product Version: 3.2

- 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 Credential
HTTP Methods | GET

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/settings/data/pruneDataConfigsByGroup/{category}

## Request Parameters

Attribute | Source | Description
--- | --- | ---
category String | path | Required Category name. Possible values are 'OpticalDevice', 'Admin', 'TrendData', 'RRM', 'Report', 'Statistics', 'Others'.

## Response Parameters

Attribute | Description
--- | ---
pruneDataConfigs PruneDataConfigDTO[] | List of data pruning configurations.
Attribute | Description
--- | ---
age int | Specifies the maximum data retention period in hours for all records in the database.
ageAttribute String | Attribute used for age calculation.
maxRecords int | Specifies the maximum number of records to retain in a particular database table.
tableName String | Table name

## 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://10.64.88.203/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{category}

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <pruneDataConfigListDTO>
        <pruneDataConfigs>
          <pruneDataConfigs>
            <age>1</age>
            <ageAttribute>String value</ageAttribute>
            <maxRecords>1</maxRecords>
            <tableName>String value</tableName>
          </pruneDataConfigs>
          <pruneDataConfigs>
            <age>11</age>
            <ageAttribute>Another string value</ageAttribute>
            <maxRecords>11</maxRecords>
            <tableName>Another string value</tableName>
          </pruneDataConfigs>
        </pruneDataConfigs>
      </pruneDataConfigListDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{category}.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{
          category
        }",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "pruneDataConfigListDTO" : {
          "pruneDataConfigs" : {
            "pruneDataConfigs" : [{
              "age" : 1,
              "ageAttribute" : "String value",
              "maxRecords" : 1,
              "tableName" : "String value"
            },
            {
              "age" : 11,
              "ageAttribute" : "Another string value",
              "maxRecords" : 11,
              "tableName" : "Another string value"
            }]
          }
        }
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
category String | path | Required Category name. Possible values are 'OpticalDevice', 'Admin', 'TrendData', 'RRM', 'Report', 'Statistics', 'Others'.

## Response Parameters

Attribute | Description
--- | ---
pruneDataConfigs PruneDataConfigDTO[] | List of data pruning configurations.
Attribute | Description
--- | ---
age int | Specifies the maximum data retention period in hours for all records in the database.
ageAttribute String | Attribute used for age calculation.
maxRecords int | Specifies the maximum number of records to retain in a particular database table.
tableName String | Table name

## 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://10.64.88.203/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <pruneDataConfigListDTO>
        <pruneDataConfigs>
          <pruneDataConfigs>
            <age>1</age>
            <ageAttribute>String value</ageAttribute>
            <maxRecords>1</maxRecords>
            <tableName>String value</tableName>
          </pruneDataConfigs>
          <pruneDataConfigs>
            <age>11</age>
            <ageAttribute>Another string value</ageAttribute>
            <maxRecords>11</maxRecords>
            <tableName>Another string value</tableName>
          </pruneDataConfigs>
        </pruneDataConfigs>
      </pruneDataConfigListDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "pruneDataConfigListDTO" : [ {
          "pruneDataConfigs" : {
            "pruneDataConfigs" : [ {
              "age" : 1,
              "ageAttribute" : "String value",
              "maxRecords" : 1,
              "tableName" : "String value"
            }, {
              "age" : 11,
              "ageAttribute" : "Another string value",
              "maxRecords" : 11,
              "tableName" : "Another string value"
            } ]
          }
        } ]
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
category String | path | Required Category name. Possible values are 'OpticalDevice', 'Admin', 'TrendData', 'RRM', 'Report', 'Statistics', 'Others'.

## Response Parameters

Attribute | Description
--- | ---
pruneDataConfigs PruneDataConfigDTO[] | List of data pruning configurations.
Attribute | Description
--- | ---
age int | Specifies the maximum data retention period in hours for all records in the database.
ageAttribute String | Attribute used for age calculation.
maxRecords int | Specifies the maximum number of records to retain in a particular database table.
tableName String | Table name

## 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://10.64.88.203/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <pruneDataConfigListDTO>
        <pruneDataConfigs>
          <pruneDataConfigs>
            <age>1</age>
            <ageAttribute>String value</ageAttribute>
            <maxRecords>1</maxRecords>
            <tableName>String value</tableName>
          </pruneDataConfigs>
          <pruneDataConfigs>
            <age>11</age>
            <ageAttribute>Another string value</ageAttribute>
            <maxRecords>11</maxRecords>
            <tableName>Another string value</tableName>
          </pruneDataConfigs>
        </pruneDataConfigs>
      </pruneDataConfigListDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "pruneDataConfigListDTO" : [ {
          "pruneDataConfigs" : {
            "pruneDataConfigs" : [ {
              "age" : 1,
              "ageAttribute" : "String value",
              "maxRecords" : 1,
              "tableName" : "String value"
            }, {
              "age" : 11,
              "ageAttribute" : "Another string value",
              "maxRecords" : 11,
              "tableName" : "Another string value"
            } ]
          }
        } ]
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v4/op/settings/data/pruneDataConfigsByGroup/{category}

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
category String | path | Required Category name. Possible values are 'OpticalDevice', 'Admin', 'TrendData', 'RRM', 'Report', 'Statistics', 'Others'.

## Response Parameters

Attribute | Description
--- | ---
pruneDataConfigs PruneDataConfigDTO[] | List of data pruning configurations.
Attribute | Description
--- | ---
age int | Specifies the maximum data retention period in hours for all records in the database.
ageAttribute String | Attribute used for age calculation.
maxRecords int | Specifies the maximum number of records to retain in a particular database table.
tableName String | Table name

## 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://10.64.88.203/webacs/api/v4/op/settings/data/pruneDataConfigsByGroup/{category}

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v4/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <pruneDataConfigListDTO>
        <pruneDataConfigs>
          <pruneDataConfigs>
            <age>1</age>
            <ageAttribute>String value</ageAttribute>
            <maxRecords>1</maxRecords>
            <tableName>String value</tableName>
          </pruneDataConfigs>
          <pruneDataConfigs>
            <age>11</age>
            <ageAttribute>Another string value</ageAttribute>
            <maxRecords>11</maxRecords>
            <tableName>Another string value</tableName>
          </pruneDataConfigs>
        </pruneDataConfigs>
      </pruneDataConfigListDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/settings/data/pruneDataConfigsByGroup/{category}.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/op/settings/data/pruneDataConfigsByGroup/{category}",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "pruneDataConfigListDTO" : [ {
          "pruneDataConfigs" : {
            "pruneDataConfigs" : [ {
              "age" : 1,
              "ageAttribute" : "String value",
              "maxRecords" : 1,
              "tableName" : "String value"
            }, {
              "age" : 11,
              "ageAttribute" : "Another string value",
              "maxRecords" : 11,
              "tableName" : "Another string value"
            } ]
          }
        } ]
      }
    }