The API needs to receive the following items:
Definition ID. This represents a pre-created definition that contains the entity and interim table to be used for the transaction restore. This definition is created by the Archive User.
Parameter String. A series of carat "^" delimited parameters as a single string that include the following:
Transaction Criteria. This represents the unique key of the transaction to be restored. The unique key can be either a primary or a composite key, but it should match the unique key defined in the interim table for the entity selected in the Restore Definition.
If a Program Callback is being used and the Program Callback requires input parameters, then additional parameter values are to be included in the Transaction Criteria.
When submitted through the Data Archive UI, the Restore Workbench allows the user to select the Entity, the Interim table, and the selection criteria to use to perform the restore. By pre-creating the Restore Definition, the calling program can hard-code the Restore Definition ID, or a new metadata table can be created that maps specific types of transactions to specific Restore Definitions.
A Program Callback feature allows a secondary program to be executed by the Transaction Restore API itself. The Program Callback can be a PL/SQL stored procedure or a Java program.
The calling program is also responsible for passing the selection criteria to the API. In this case the selection criterion is the specific transaction to be restored. Since all of these values are specific to the archive metadata being used, it is the requirement of the calling program to determine these values, and not the purpose of the API itself to determine these values. If a Program Callback is being used the Program Callback requires input parameters, then the values for these parameters will be appended to the Transaction Restore selection criteria.
The final input parameter will be an indicator to restore the transaction immediately or as part of batch processing to occur later.