Table of Contents
- List of Examples
- List of Figures
- List of Tables
- Title and Copyright Information
- Preface
- Changes in This Release for Oracle REST Data Services Installation, Configuration, and Development Guide
-
1
Introduction to Oracle REST Data Services
- About Oracle REST Data Services
- Understanding the Installation Process
-
Configuring and Installing Oracle REST Data Services
- About Using the Command-Line Interface
- About the Database Users Used by Oracle REST Data Services
- Privileges Required for Oracle REST Data Services
-
Downloading, Configuring and Installing Oracle REST Data Services
- ORDS Installer Privileges Script
- Advanced Installation Using Command-Line Prompts
-
ORDS Parameter File
-
Parameters Used in ORDS Parameter
File
- Parameters for Database Connection
- Parameters for Installing Oracle REST Data Services
- Parameters for Enabling SQL Developer Web
- Parameters for Enabling REST-Enabled SQL
- Parameters for Enabling Database API
- Parameters for Installing into the CDB
- Parameters for Configuring Application Express
- Parameters for Running in Standalone Mode
- Miscellaneous Parameters
-
Parameters Used in ORDS Parameter
File
- Simple Installation Using a Parameter File
- Silent Installation Using a Parameter File
- Changing Default Configuration from the Command Line
- Validating the Oracle REST Data Services Installation
- If You Want to Reinstall or Uninstall (Remove) Oracle REST Data Services
- Using SQL Developer Oracle REST Data Services Administration (Optional)
- Using OAuth2 in Non-HTTPS Environments
- Running in Standalone Mode
-
Deploying to Oracle WebLogic Server
- About Oracle WebLogic Server
- Downloading, Installing, and Configuring Oracle REST Data Services
- Configuring Oracle Application Express Images
- Launching the Administration Server Console
- Installing the Oracle WebLogic Server Deployment
- Configuring WebLogic to Handle HTTP Basic Challenges Correctly
- Verifying the State and Health of ords and i
- Deploying to Apache Tomcat
- Upgrading Oracle REST Data Services
- Using a Bequeath Connection to Install, Upgrade, Validate, or Uninstall Oracle REST Data Services
- Authorizing Oracle REST Data Services to Access Oracle Data Guard Protected Users
-
2
Configuring Oracle REST Data Services (Advanced)
- Configuring Multiple Databases
- Support for Oracle RAC Fast Connection Failover
- Configuring Security, Caching, Pre- and Post Processing, Environment, and Excel Settings
- Configuring REST-Enabled SQL Service Settings
- Configuring the Maximum Number of Rows Returned from a Query
- Configuring the Custom Error Pages
- Developing RESTful Services for Use with Oracle REST Data Services
- Managing ORDS Administrator Privilege
- Managing ORDS Runtime Privilege
- 3 Installing and Configuring Customer Managed ORDS on Autonomous Database
-
4
Using the Multitenant Architecture with Oracle REST Data Services
- Setting Up ORDS in a CDB Environment
-
Setting Up ORDS in an Application Container
- Prerequisites for Creating ORDS in an Application Container
- Installing ORDS in the Application Root Container
- Creating an Application Seed
- Creating an Application PDB from the Application Seed
- ORDS Configuration Files Setup
- Running ORDS
- Validating ORDS in the Application Root Container
- 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)
-
5
Developing Oracle REST Data Services Applications
- Introduction to Relevant Software
-
Getting Started with RESTful Services
- RESTful Services Terminology
- About Request Path Syntax Requirements
- "Getting Started" Documents Included in Installation
- About cURL and Testing RESTful Services
- Automatic Enabling of Schema Objects for REST Access (AutoREST)
- Manually Creating RESTful Services Using SQL and PL/SQL
- About Working with Dates Using Oracle REST Data Services
- Configuring Secure Access to RESTful Services
- About Oracle REST Data Services User Roles
- Authenticating Against WebLogic Server User Repositories
- Integrating with Existing Group/Role Models
- Integrating Oracle REST Data Services and WebLogic Server
- Using the Oracle REST Data Services PL/SQL API
- Oracle REST Data Services Database Authentication
- Overview of Pre-hook Functions
- Generating Hyperlinks
-
6
REST-Enabled SQL Service
- REST-Enabled SQL Service Terminology
- Configuring the REST-Enabled SQL Service
- Using cURL with REST-Enabled SQL Service
- Getting Started with the REST-Enabled SQL Service
- REST-Enabled SQL Service Examples
- REST-Enabled SQL Request and Response Specifications
- Supported SQL, SQL*Plus, and SQLcl Statements
- 7 Migrating from mod_plsql to ORDS
-
8
Oracle REST Data Services PL/SQL Package Reference
- ORDS.CREATE_ROLE
- ORDS.CREATE_SERVICE
- ORDS.DEFINE_HANDLER
- ORDS.DEFINE_MODULE
- ORDS.DEFINE_PARAMETER
- ORDS.DEFINE_PRIVILEGE
- ORDS.DEFINE_SERVICE
- ORDS.DEFINE_TEMPLATE
- ORDS.DELETE_MODULE
- ORDS.DELETE_PRIVILEGE
- ORDS.DELETE_ROLE
- ORDS.DROP_REST_FOR_SCHEMA
- ORDS.ENABLE_OBJECT
- ORDS.DROP_REST_FOR_OBJECT
- ORDS.ENABLE_SCHEMA
- ORDS.PUBLISH_MODULE
- ORDS.RENAME_MODULE
- ORDS.RENAME_PRIVILEGE
- ORDS.RENAME_ROLE
- ORDS.SET_MODULE_ORIGINS_ALLOWED
- ORDS.SET_URL_MAPPING
- ORDS.SET_SESSION_DEFAULTS
- ORDS.RESET_SESSION_DEFAULTS
-
9
Oracle REST Data Services Administration PL/SQL Package Reference
- ORDS_ADMIN.CREATE_ROLE
- ORDS_ADMIN.DEFINE_HANDLER
- ORDS_ADMIN.DEFINE_MODULE
- ORDS_ADMIN.DEFINE_PARAMETER
- ORDS_ADMIN.DEFINE_PRIVILEGE
- ORDS_ADMIN.DEFINE_SERVICE
- ORDS_ADMIN.DEFINE_TEMPLATE
- ORDS_ADMIN.DELETE_MODULE
- ORDS_ADMIN.DELETE_PRIVILEGE
- ORDS_ADMIN.DELETE_ROLE
- ORDS_ADMIN.DROP_REST_FOR_SCHEMA
- ORDS_ADMIN.ENABLE_OBJECT
- ORDS_ADMIN.DROP_REST_FOR_OBJECT
- ORDS_ADMIN.ENABLE_SCHEMA
- ORDS_ADMIN.PUBLISH_MODULE
- ORDS_ADMIN.RENAME_MODULE
- ORDS_ADMIN.RENAME_PRIVILEGE
- ORDS_ADMIN.RENAME_ROLE
- ORDS_ADMIN.SET_MODULE_ORIGINS_ALLOWED
- ORDS_ADMIN.SET_URL_MAPPING
- ORDS_ADMIN.ENABLE_HOUSEKEEPING_JOB
- ORDS_ADMIN.DROP_HOUSEKEEPING_JOB
- ORDS_ADMIN.PERFORM_HOUSEKEEPING
- ORDS_ADMIN.SET_SESSION_DEFAULTS
- ORDS_ADMIN.RESET_SESSION_DEFAULTS
- ORDS_ADMIN.PROVISION_ADMIN_ROLE
- ORDS_ADMIN.PROVISION_RUNTIME_ROLE
- ORDS_ADMIN.UNPROVISION_ ROLES
- 10 Implicit Parameters
- 11 OAUTH PL/SQL Package Reference
- 12 Enabling ORDS Database API
- A Oracle REST Data Services Database Type Mappings
- B About the Oracle REST Data Services Configuration Files
- C Troubleshooting Oracle REST Data Services
-
D
Creating an Image Gallery
- Before You Begin
- Creating the Gallery Database Table
- Creating the Gallery RESTful Service Module
- Trying Out the Gallery RESTful Service
- Creating the Gallery Application
- Trying Out the Gallery Application
- Securing the Gallery RESTful Services
-
Accessing the RESTful Services from a Third Party Application
- Creating the Third Party Developer User
- Registering the Third Party Application
- Acquiring an Access Token
- Using an Access Token
- About Browser Origins
- Configuring a RESTful Service for Cross Origin Resource Sharing
- Acquiring a Token Using the Authorization Code Protocol Flow
- About Securing the Access Token
- E Third-Party License Information
- Index