History recovery REST URLs
- Last UpdatedApr 21, 2025
- 2 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The following is a list of available s:
|
verb |
Relative |
Action |
|---|---|---|
|
|
api/v1/configuration/<componentId>/historyRecoveries |
Returns all history recoveries statuses. |
|
|
api/v1/configuration/<componentId>/historyRecoveries |
Initiates a new history recovery, returns the id of the operation. |
|
|
api/v1/configuration/<componentId>/historyRecoveries |
Cancels all active history recovery operations and removes states. |
|
|
api/v1/configuration/<componentId>/historyRecoveries/<operationId> |
Gets the status of an individual history recovery. |
|
|
api/v1/configuration/<componentId>/historyRecoveries/<operationId> |
Cancels history recovery and removes the state. |
|
|
api/v1/configuration/<componentId>/historyRecoveries/<operationId>/cancel |
Cancels history recovery. |
|
|
api/v1/configuration/<componentId>/historyRecoveries/<operationId>/resume |
Resumes canceled or failed history recovery operation (202) from the checkpoint. Note: If the <operationId> is not found, a 404 error message will be returned. |
Note: Replace <componentId> with the Id of your adapter component. Replace <operationId> with the Id of the history recovery operation for which you want to perform the action.