Table of Contents

Search

  1. Preface
  2. Starting Data Archive
  3. System Configuration
  4. Database Users and Privileges
  5. Source Connections
  6. Target Connections
  7. Archive Store Configuration
  8. Datatype Mapping
  9. Database Optimization
  10. SAP Application Retirement
  11. z/OS Source Data Retirement
  12. Seamless Data Access
  13. Data Discovery Portal
  14. Security
  15. SSL Communication with Data Vault
  16. LDAP User Authentication
  17. Auditing
  18. Running Jobs from External Applications
  19. Salesforce Archiving Administrator Tasks
  20. Upgrading Oracle History Data
  21. Upgrading PeopleSoft History Data
  22. Data Archive Maintenance
  23. Appendix A: Datetime and Numeric Formatting
  24. Appendix B: Data Archive Connectivity

Administrator Guide

Administrator Guide

Forming the URL for the File Archive Transaction Restore API

Forming the URL for the File Archive Transaction Restore API

To restore a file archive transaction or transactions through the API, form a URL that contains the required parameters.
  1. Use the following format to form the URL:
    http://<host>:<port>/API/fileArchiveTxnRestore.htm?definitionId=<definitionId>& whereClause=<whereClase>& username=<username>& password=<encryptedPassword>
  2. Replace the text in brackets with the appropriate parameter values.
  3. Use the following values to create the WHERE clause that identifies the records that you want to restore:
    • Brace
      or
      NOBrace
      to indicate the presence or absence of the left brace.
      Use the
      Brace
      or
      NOBrace
      signifiers to indicate whether or not the search criteria contains a bracket.
      For example, the following type of search criteria does not require brackets:
      First_Name EQ John and middle_name EQ rob OR last_name EQ smith
      However, you can also create search criteria that contains brackets. For example:
      (First_Name EQ John and middle_name EQ rob) OR last_name EQ smith
      .
      Or,
      First_Name EQ John and (middle_name EQ Rob OR last_name EQ smith)
      The URL requires the use of
      NOBrace
      if the search criteria does not contain brackets.
    • Table name and column name separate by a period. For example,
      CUSTOMERS.CUSTOMER_ID
      .
    • Operator
    • Column value or, if the operator is
      IS NULL
      or
      NOT NULL
      , use
      NOValue
      .
    • Brace
      or
      NOBrace
      to indicate the presence or absence of the right brace.
    • AND
      ,
      OR
      , or
      NOCondition
      for condition.
    Each criteria should be separated by four hash (#) symbols. Each value in a criteria should be separated by three hash (#) symbols.
  4. Form the URL.
    Replace the following in the WHERE clause:
    • Replace all hash (#) symbols with %23. For example, change
      ###EQ###
      to
      %23%23%23EQ%23%23%23
      .
    • Replace all left parentheses with %28.
    • Replace all left parentheses with %29.
Example
You have created one file archive transaction restore definition on the entity "XYZ_001." The definition ID is 10. The entity driving table is "XYZ" and the table has 2 columns, "ID" (integer) and "Name"(varchar). The WHERE clause is "ID<10." You want to use the API to create and schedule the job with the following job parameters:
Parameter
Value
Description
Host
10.74.0.233
Must be configured as a valid host in the
conf.properties
file.
Port
8080
Port number.
Definition ID
10
ID for the definition created in the Data Archive user interface.
After you create the restore definition from the Data Archive user interface, run the following query to return the definition ID:
SELECT MAX(DEFN_ID) from AM_DEFN
Username
User1
Data Archive username.
Password
adscsadnacasdad
Encrypted password returned by the encryptPassword.bat or encryptPassword.sh utilities.
WhereClause
ID >= 10
WHERE clause to filter records for the transaction restore.
The following URL runs the file archive transaction restore with the specified job parameters:
http://10.74.0.233:8080/API/fileArchiveTxnRestore.htm?definitionId=10&username=User1&password=adscsadnacasdad&whereClause=%23%23%23XYZ.ID%23%23%23GTEQ%23%23%2310%23%23%23NoBrace%23%23%23false%23%23%23NOCondition

0 COMMENTS

We’d like to hear from you!