Oracle® REST Data Services Installation, Configuration, and Development Guide Release 20.4 F37790-04 February 2021 Oracle REST Data Services Installation, Configuration, and Development Guide, Release 20.4 F37790-04 Copyright © 2011, 2021, Oracle and/or its affiliates. Primary Authors: Mamata Basapur, Chuck Murray Contributors: Colm Divilly, Sharon Kennedy, Ganesh Pitchaiah, Kris Rice, Elizabeth Saunders, Jason Straub, Vladislav Uvarov This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle. Contents Preface Audience xviii Documentation Accessibility xviii Related Documents xix Conventions xix Changes in This Release for Oracle REST Data Services Installation, Configuration, and Development Guide Changes in Oracle REST Data Services Release 20.4 xx 1 Introduction to Oracle REST Data Services About Oracle REST Data Services 1-1 Understanding the Installation Process 1-1 Supported Java EE Application Servers 1-2 Supported Oracle Application Express (APEX) Versions 1-2 System Requirements 1-2 About Installing Oracle REST Data Services 1-3 Configuring and Installing Oracle REST Data Services 1-3 About Using the Command-Line Interface 1-4 About the Database Users Used by Oracle REST Data Services 1-4 Privileges Required for Oracle REST Data Services 1-5 Downloading, Configuring and Installing Oracle REST Data Services 1-7 ORDS Installer Privileges Script 1-8 Advanced Installation Using Command-Line Prompts 1-8 ORDS Parameter File 1-14 Simple Installation Using a Parameter File 1-27 Silent Installation Using a Parameter File 1-28 Changing Default Configuration from the Command Line 1-29 Validating the Oracle REST Data Services Installation 1-30 If You Want to Reinstall or Uninstall (Remove) Oracle REST Data Services 1-31 Using SQL Developer Oracle REST Data Services Administration (Optional) 1-32 iii About SQL Developer Oracle REST Data Services Administration 1-32 Configuring an Administrator User 1-33 Using OAuth2 in Non-HTTPS Environments 1-33 Running in Standalone Mode 1-34 Starting in Standalone Mode 1-34 Converting a Private Key to DER (Linux and Unix) 1-35 Stopping the Server in Standalone Mode 1-36 Configuring a Doc Root for Non-Application Express Static Resources 1-36 Deploying to Oracle WebLogic Server 1-37 About Oracle WebLogic Server 1-37 Downloading, Installing, and Configuring Oracle REST Data Services 1-38 Configuring Oracle Application Express Images 1-38 Launching the Administration Server Console 1-38 Installing the Oracle WebLogic Server Deployment 1-39 Configuring WebLogic to Handle HTTP Basic Challenges Correctly 1-40 Verifying the State and Health of ords and i 1-41 Deploying to Apache Tomcat 1-42 About Apache Tomcat 1-42 Downloading, Installing, and Configuring Oracle REST Data Services 1-42 Configuring Oracle Application Express Images 1-42 Installing the Apache Tomcat Deployment 1-43 Monitoring ORDS 1-43 Enabling the ORDS Instance API 1-44 Authorization for Using the ORDS Instance API 1-44 API Document 1-44 Using the Instance API 1-44 Upgrading Oracle REST Data Services 1-44 Using a Bequeath Connection to Install, Upgrade, Validate, or Uninstall Oracle REST Data Services 1-46 Authorizing Oracle REST Data Services to Access Oracle Data Guard Protected Users 1-46 2 Configuring Oracle REST Data Services (Advanced) Configuring Multiple Databases 2-1 About the Request URL 2-1 Configuring Additional Databases 2-2 Routing Based on the Request Path Prefix 2-3 Example of Routing Based on the Request Path Prefix 2-3 Routing Based on the Request URL Prefix 2-4 Example of Routing Based on the Request URL Prefix 2-4 Support for Oracle RAC Fast Connection Failover 2-4 iv Configuring Security, Caching, Pre- and Post Processing, Environment, and Excel Settings 2-5 Configuring REST-Enabled SQL Service Settings 2-6 Configuring the Maximum Number of Rows Returned from a Query 2-6 Configuring the Custom Error Pages 2-7 Developing RESTful Services for Use with Oracle REST Data Services 2-7 Managing ORDS Administrator Privilege 2-7 Provisioning ORDS_ADMINISTRATOR_ROLE to a User 2-8 Unprovisioning ORDS_ADMINISTRATOR_ROLE from a User 2-8 Managing ORDS Runtime Privilege 2-8 Provisioning ORDS_RUNTIME_ROLE to a User 2-9 Unprovisioning ORDS_RUNTIME_ROLE from a User 2-9 3 Installing and Configuring Customer Managed ORDS on Autonomous Database About Customer Managed Oracle REST Data Services on Autonomous Database 3-1 Downloading Wallet and Verifying Connection to Autonomous Database 3-2 Creating Customer Managed Oracle REST Data Services User Role 3-3 Downloading and Configuring Oracle REST Data Services 3-4 Preparing and Starting ORDS 3-5 4 Using the Multitenant Architecture with Oracle REST Data Services Setting Up ORDS in a CDB Environment 4-1 Installation Enabling Multiple Releases 4-2 Command Line Installation 4-2 Advanced Installation 4-2 Silent Installation 4-3 Upgrading Oracle REST Data Services in a CDB Environment 4-4 Migrating Oracle REST Data Services in the CDB to Enable Multiple Releases 4-4 Making All PDBs Addressable by Oracle REST Data Services 4-4 Uninstalling Oracle REST Data Services in a CDB Environment 4-4 Setting Up ORDS in an Application Container 4-4 Prerequisites for Creating ORDS in an Application Container 4-5 Creating an Application Root Container 4-6 Installing ORDS in the Application Root Container 4-6 Creating an Application Seed 4-7 Creating an Application PDB from the Application Seed 4-8 ORDS Configuration Files Setup 4-9 Specifying the ORDS Configuration Folder 4-9 v Creating the ORDS Configuration Files for the Application Root Container 4-10 Making all Application PDBs in an Application Root Container Addressable by ORDS 4-11 Running ORDS 4-11 Validating ORDS in the Application Root Container 4-12 Upgrading ORDS in the Application Container 4-13 Uninstalling ORDS from the Application Container 4-14 Verifying ORDS in the Application