Description
Runs the history purge function.
Parameters
| Name | Description |
|---|---|
| numberOfDaysToKeep |
Location: query Type: integer (int32) The number of days for which the data will be preserved in the database.
The valid value for this parameter is between 1 and 3650. Set this
parameter to -1 if you are using either untilWhenTimestamp
or numberOfMonthsToKeep. Using this parameter will
archive all history that will be purged and overwrite existing archive
files in the /data/Archive directory.
|
| numberOfMonthsToKeep |
Location: query Type: integer (int32) The number of months for which the data will be preserved in the
database. The valid value for this parameter is between 0 to infinite
months. Set this parameter to -1 if you are using either
untilWhenTimestamp or numberOfDaysToKeep.
Using this parameter will not archive any data.
|
| untilWhenTimestamp |
Location: query Type: string The string specifying the point in time after which history is to be
preserved. The valid timestamp pattern is YYYY-MM[-DD[
HH:MM:SS[.mmm]]]. Set this parameter with an empty string "" if you
are using either numbeOfDaysToKeep or
numberOfMonthsToKeep. Using this parameter will not
archive any data.
|
| waitOption |
Location: query Type: boolean The Boolean value. If set to true, the purge will be
performed and the result will be returned when completed. The default
value is false.
|
Responses
| Code | Description |
|---|---|
| 204 |
Type: integer (int32) Returns 0 (zero) when the purge service has successfully completed.
|