History recovery parameters
- Last UpdatedSep 22, 2025
- 1 minute read
- PI System
- Adapter for RDBMS 1.1
- Adapters
The following parameters are available for configuring history recovery:
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
string |
The Id of the history recovery Note: You cannot run multiple history recoveries with the same . |
|
startTime |
datetime |
Time when the the first data items are collected. Note: The supported format for this parameter is ISO 8601-1:2019 (yyyy-MM-ddTHH:mm:ssZ). |
|
endTime |
datetime |
Time when the last data items are collected. Note: The supported format for this parameter is ISO 8601-1:2019 (yyyy-MM-ddTHH:mm:ssZ). |
|
checkpoint |
datetime |
The latest timestamp that the history recovery has completed with the range being between startTime and endTime. |
|
items |
double |
The amount of data selection items in the history recovery operation. |
|
recoveredEvents |
double |
Number of events that the history recovery found on the data source. |
|
progress |
double |
Progress of the history recovery (number of data items found through the history recovery). |
|
status |
enum |
Status of the history recovery. The following statuses are available:
|
|
errors |
string |
Errors encountered during the history recovery. |