Retrieves data pruning configuration for particular table.
Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Credential |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/op/settings/data/pruneDataConfig/{tableName}Request Parameters
Attribute | Source | Description |
---|---|---|
tableName String |
path |
RequiredTable name |
Response Parameters
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://localhost/webacs/api/v1/op/settings/data/pruneDataConfig/{tableName}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/settings/data/pruneDataConfig/{tableName}" rootUrl="https://localhost/webacs/api/v1/op">
<pruneDataConfigDTO>
<age>1</age>
<ageAttribute>String value</ageAttribute>
<maxRecords>1</maxRecords>
<tableName>String value</tableName>
</pruneDataConfigDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/settings/data/pruneDataConfig/{tableName}.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/settings\/data\/pruneDataConfig\/{
tableName
}",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"pruneDataConfigDTO" : {
"age" : 1,
"ageAttribute" : "String value",
"maxRecords" : 1,
"tableName" : "String value"
}
}
}