Retrieves data pruning configurations for given category.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{category}
Request Parameters
category
String
|
path
|
RequiredCategory name. Possible values are 'Optical Devices', 'Admin', 'Trend Data', 'RRM', 'Report', 'Statistics', 'Others'.
|
Response Parameters
pruneDataConfigs
PruneDataConfigDTO[]
|
List of data pruning configurations.
|
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
|
|
|
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/pruneDataConfigsByGroup/{category}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://localhost/webacs/api/v1/op">
<pruneDataConfigListDTO>
<pruneDataConfigs>
<pruneDataConfigs>
<age>1</age>
<ageAttribute>String value</ageAttribute>
<maxRecords>1</maxRecords>
<tableName>String value</tableName>
</pruneDataConfigs>
</pruneDataConfigs>
</pruneDataConfigListDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/settings/data/pruneDataConfigsByGroup/{category}.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/settings\/data\/pruneDataConfigsByGroup\/{
category
}",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"pruneDataConfigListDTO" : {
"pruneDataConfigs" : {
"pruneDataConfigs" : {
"age" : 1,
"ageAttribute" : "String value",
"maxRecords" : 1,
"tableName" : "String value"
}
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
category
String
|
path
|
RequiredCategory name. Possible values are 'Optical Devices', 'Admin', 'Trend Data', 'RRM', 'Report', 'Statistics', 'Others'.
|
Response Parameters
pruneDataConfigs
PruneDataConfigDTO[]
|
List of data pruning configurations.
|
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
|
|
|
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/v2/op/settings/data/pruneDataConfigsByGroup/{category}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://localhost/webacs/api/v2/op">
<pruneDataConfigListDTO>
<pruneDataConfigs>
<pruneDataConfigs>
<age>1</age>
<ageAttribute>String value</ageAttribute>
<maxRecords>1</maxRecords>
<tableName>String value</tableName>
</pruneDataConfigs>
</pruneDataConfigs>
</pruneDataConfigListDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/settings/data/pruneDataConfigsByGroup/{category}",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"pruneDataConfigListDTO" : [ {
"pruneDataConfigs" : {
"pruneDataConfigs" : [ {
"age" : 1,
"ageAttribute" : "String value",
"maxRecords" : 1,
"tableName" : "String value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
category
String
|
path
|
RequiredCategory name. Possible values are 'Optical Devices', 'Admin', 'Trend Data', 'RRM', 'Report', 'Statistics', 'Others'.
|
Response Parameters
pruneDataConfigs
PruneDataConfigDTO[]
|
List of data pruning configurations.
|
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
|
|
|
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/settings/data/pruneDataConfigsByGroup/{category}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}" rootUrl="https://localhost/webacs/api/v3/op">
<pruneDataConfigListDTO>
<pruneDataConfigs>
<pruneDataConfigs>
<age>1</age>
<ageAttribute>String value</ageAttribute>
<maxRecords>1</maxRecords>
<tableName>String value</tableName>
</pruneDataConfigs>
<pruneDataConfigs>
<age>1</age>
<ageAttribute>String value</ageAttribute>
<maxRecords>1</maxRecords>
<tableName>String value</tableName>
</pruneDataConfigs>
</pruneDataConfigs>
</pruneDataConfigListDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/settings/data/pruneDataConfigsByGroup/{category}",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"pruneDataConfigListDTO" : [ {
"pruneDataConfigs" : {
"pruneDataConfigs" : [ {
"age" : 1,
"ageAttribute" : "String value",
"maxRecords" : 1,
"tableName" : "String value"
}, {
"age" : 1,
"ageAttribute" : "String value",
"maxRecords" : 1,
"tableName" : "String value"
} ]
}
} ]
}
}