Table of Contents

• List of Examples
• List of Tables
• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
  • Related Documents
  • Conventions
• Changes in Release 22.1 Oracle REST Data Services Installation and Configuration Guide
  • Changes in Oracle REST Data Services Release 22.1
    • Other Changes
• 1 Oracle REST Data Services Installation Checklist
  • System Requirements
  • Supported Java EE Application Servers
  • Supported Oracle Application Express (APEX) Versions
  • ORDS Installer Privileges Script
  • Privileges Granted to the Oracle REST Data Services Users
  • About the Database Users Used by Oracle REST Data Services
  • About Command-Line Interface
  • About Online Help
• 2 Installing and Configuring Oracle REST Data Services
  • Installing Oracle REST Data Services
    • Downloading ORDS
    • Setting Up the Configuration Folder Structure
      • Specifying the New ORDS Configuration Folder
    • Interactive Command-Line Interface Installation
      • Entering a Number to Select the Type of Installation
      • Entering a Number to Select the Database Pool
      • Entering the Database Pool Name
      • Entering a Number to Select the Database Connection
      • Entering the Database Host Name
      • Entering the Database Listener Port
      • Entering the Database Service Name
      • Entering the TNS Location
      • Entering a Number to Select the TNS Network Alias
      • Entering the Custom Database URL
      • Entering the Administrator Username
      • Entering the Database Password
      • Entering the Default Tablespace
      • Entering a Number to Select Additional Feature(s)
      • Entering a Number to Configure and Start ORDS in Standalone Mode
      • Entering a Number to Use HTTP or HTTPS Protocol
      • Entering the HTTP Port
      • Entering the HTTPS Port
      • Entering a Number to Select the Certificate Type
      • Entering the SSL Hostname
      • Entering the Path for the SSL Certificate
      • Entering the Path for the SSL Certificate’s Private Key
      • Entering the APEX Static Resources Location
    • Non-Interactive Command-Line Interface Installation (Silent)
      • Understanding Command Options for Command-Line Interface Installation
      • Using Input Redirection
  • Repairing the Oracle REST Data Services Installation
    • Command Options for Repair CLI
  • Upgrading Oracle REST Data Services
  • Uninstalling Oracle REST Data Services
    • Interactive Uninstall CLI
      • Entering a Number to Select the Database Pool
      • Entering a Number to Select the Database Connection Type
      • Entering the Database Host Name
      • Entering the Database Listener Port
      • Entering the Database Service Name
      • Entering the TNS Location
      • Entering a Number to Select the TNS Network Alias
      • Entering the Custom Database URL
      • Entering the Administrator Username
      • Entering the Database Password for SYS AS SYSDBA
      • Entering an Option for Uninstalling ORDS
    • Non-Interactive Uninstall CLI
      • Using Input Redirection
      • Command options for Uninstall CLI
  • Updating the Configuration Settings
• 3 Configuring Oracle REST Data Services for Multiple Databases
  • About the Request URL
  • Configuring Additional Databases
  • Advanced Routing
  • Routing Based on the Request Path
  • Routing Based on the Request Hostname
• 4 Miscellaneous Configuration Options of Oracle REST Data Services
  • Support for Oracle RAC Fast Connection Failover
  • Configuring ORDS with Kerberos Setup
  • Authorizing Oracle REST Data Services to Access Oracle Data Guard Protected Users
  • Configuring REST-Enabled SQL Service Settings
  • Configuring the Maximum Number of Rows Returned from a Query
  • Configuring ICAP Server Integration for Virus Scan
  • Configuring the Custom Error Pages
  • Managing ORDS Administrator Privilege
    • Provisioning ORDS_ADMINISTRATOR_ROLE to a User
    • Unprovisioning ORDS_ADMINISTRATOR_ROLE from a User
  • Managing ORDS Runtime Privilege
    • Provisioning ORDS_RUNTIME_ROLE to a User
    • Unprovisioning ORDS_RUNTIME_ROLE from a User
  • Using OAuth2 in Non-HTTPS Environments
  • Configuring ORDS Metadata Cache
• 5 Deploying and Monitoring Oracle REST Data Services
  • Deploying Oracle REST Data Services
    • Serve Commands for Running in Standalone Mode
      • Non-Interactive Serve CLI
      • Serve Command Options
      • Converting a Private Key to DER (Linux and Unix)
      • Configuring a Doc Root for Non-Application Express Static Resources
    • Oracle WebLogic Server
      • About Oracle WebLogic Server
      • Configuring Oracle Application Express Images
      • Launching the Administration Server Console
      • Deploying ORDS on Oracle WebLogic Server
      • Configuring WebLogic to Handle HTTP Basic Challenges Correctly
      • Verifying the State and Health of ords and i
    • Apache Tomcat
      • About Apache Tomcat
      • Configuring Oracle Application Express Images
      • Deploying ORDS on Apache Tomcat
    • Oracle Cloud Infrastructure
      • About Oracle Cloud Infrastructure
      • Configuring ORDS for High Availability on Oracle Cloud Infrastructure
      • Advantages of Deploying ORDS with High Availability on Oracle Cloud Infrastructure
  • Monitoring Oracle REST Data Services
    • Enabling the ORDS Instance API
    • Authorization for Using the ORDS Instance API
    • API Document
    • Using the Instance API
• 6 Using the Multitenant Architecture with Oracle REST Data Services
  • Setting Up ORDS in a CDB Environment
    • Installation Enabling Multiple Releases
      • Command Line Installation
      • Advanced Installation
      • Silent Installation
    • Upgrading Oracle REST Data Services in a CDB Environment
      • Migrating Oracle REST Data Services in the CDB to Enable Multiple Releases
    • Uninstalling Oracle REST Data Services in a CDB Environment
  • Setting Up ORDS in an Application Container
    • Prerequisites for Creating ORDS in an Application Container
      • Creating an Application Root Container
    • Installing ORDS in the Application Root Container
    • Creating an Application Seed
    • Creating an Application PDB from the Application Seed
    • Configuring the PLSQL Gateway for APEX
    • ORDS Configuration Files Setup
      • Specifying the ORDS Configuration Folder
      • Creating the ORDS Configuration Files for the Application Root Container
    • Running ORDS
    • Upgrading ORDS in the Application Container
    • Uninstalling ORDS from the Application Container
    • Verifying ORDS in the Application Container
  • Making All PDBs Addressable by Oracle REST Data Services (Pluggable Mapping)
• 7 Installing and Configuring Customer Managed ORDS on Autonomous Database
  • About Customer Managed Oracle REST Data Services on Autonomous Database
  • Downloading Wallet and Verifying Connection to Autonomous Database
  • Creating an Oracle REST Data Services Runtime Database User
  • Downloading and Configuring Oracle REST Data Services
  • Preparing and Starting ORDS
• 8 Migration of Legacy Configuration
  • Migrating From Legacy Configurations Using the CLI Installation
  • Migrating URL Mapping
• A Non-Interactive ORDS CLI Commands Examples
  • Non-Interactive Install/Upgrade
  • Non-Interactive Install/Upgrade (create a proxied PLSQL Gateway User)
  • Non-Interactive Install/Upgrade (specify PLSQL Gateway User and not using RESTful Services)
  • Non-Interactive Install/Upgrade (disable a configured PLSQL Gateway)
  • Non-Interactive Uninstall ORDS
  • config CLI Examples
• B ORDS Legacy Commands and New ORDS CLI Commands
• C About the Oracle REST Data Services Configuration Files
  • Understanding the Configuration Folder Structure
  • Understanding the Configuration File Format
  • Understanding the Configurable Settings
• Index