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
Installing Oracle REST Data Services
- 1.1 About Oracle REST Data Services
- 1.2 Understanding the Installation Process
-
1.3
Configuring and Installing Oracle REST Data Services
- 1.3.1 About Using the Command-Line Interface
- 1.3.2 About the Database Users Used by Oracle REST Data Services
- 1.3.3 Privileges Required for Oracle REST Data Services
-
1.3.4
Downloading, Configuring and Installing Oracle REST Data Services
- 1.3.4.1 User with DBA Privileges
- 1.3.4.2 Advanced Installation Using Command-Line Prompts
-
1.3.4.3
Silent Installation Using a Parameter File
-
1.3.4.3.1
Parameters for Installing in Silent Mode
- 1.3.4.3.1.1 Parameters for Database Connection
- 1.3.4.3.1.2 Parameters for Installing Oracle REST Data Services
- 1.3.4.3.1.3 Parameters for Installing into the CDB
- 1.3.4.3.1.4 Parameters for Installing Application Express
- 1.3.4.3.1.5 Parameters for Installing in Standalone Mode
- 1.3.4.3.1.6 Miscellaneous Parameters
-
1.3.4.3.1
Parameters for Installing in Silent Mode
- 1.3.4.4 Validating the Oracle REST Data Services Installation
- 1.3.4.5 If You Want to Reinstall or Uninstall (Remove) Oracle REST Data Services
- 1.3.5 Using SQL Developer Oracle REST Data Services Administration (Optional)
- 1.3.6 Using OAuth2 in Non-HTTPS Environments
- 1.4 Running in Standalone Mode
-
1.5
Deploying to Oracle WebLogic Server
- 1.5.1 About Oracle WebLogic Server
- 1.5.2 Downloading, Installing, and Configuring Oracle REST Data Services
- 1.5.3 Configuring Oracle Application Express Images
- 1.5.4 Launching the Administration Server Console
- 1.5.5 Installing the Oracle WebLogic Server Deployment
- 1.5.6 Configuring WebLogic to Handle HTTP Basic Challenges Correctly
- 1.5.7 Verifying the State and Health of ords and i
- 1.6 Deploying to Apache Tomcat
- 1.7 Upgrading Oracle REST Data Services
- 1.8 Using a Bequeath Connection to Install, Upgrade, Validate, or Uninstall Oracle REST Data Services
-
2
Configuring Oracle REST Data Services (Advanced)
- 2.1 Configuring Multiple Databases
- 2.2 Using the Multitenant Architecture with Oracle REST Data Services
- 2.3 Support for Oracle RAC Fast Connection Failover
- 2.4 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.7 Configuring the Custom Error Pages
- 2.8 Developing RESTful Services for Use with Oracle REST Data Services
-
3
Developing Oracle REST Data Services Applications
- 3.1 Introduction to Relevant Software
-
3.2
Getting Started with RESTful Services
- 3.2.1 RESTful Services Terminology
- 3.2.2 About Request Path Syntax Requirements
- 3.2.3 "Getting Started" Documents Included in Installation
- 3.2.4 About cURL and Testing RESTful Services
-
3.2.5
Automatic Enabling of Schema Objects for REST Access (AutoREST)
-
3.2.5.1
Examples: Accessing Objects Using RESTful Services
- 3.2.5.1.1 Get Schema Metadata
- 3.2.5.1.2 Get Object Metadata
- 3.2.5.1.3 Get Object Data
- 3.2.5.1.4 Get Table Data Using Paging
- 3.2.5.1.5 Get Table Data Using Query
- 3.2.5.1.6 Get Table Row Using Primary Key
- 3.2.5.1.7 Insert Table Row
- 3.2.5.1.8 Update/Insert Table Row
- 3.2.5.1.9 Delete Using Filter
- 3.2.5.1.10 Post by Batch Load
- 3.2.5.2 Filtering in Queries
- 3.2.5.3 Auto PL/SQL
-
3.2.5.1
Examples: Accessing Objects Using RESTful Services
-
3.2.6
Manually Creating RESTful Services Using SQL and PL/SQL
- 3.2.6.1 About Oracle REST Data Services Mechanisms for Passing Parameters
-
3.2.6.2
Using SQL/JSON Database Functions
-
3.2.6.2.1
Inserting Nested JSON Objects into Relational Tables
- 3.2.6.2.1.1 Usage of the :body Bind Variable
- 3.2.6.2.1.2 Example of JSON Purchase Order with Nested LineItems
- 3.2.6.2.1.3 Table Definitions for PurchaseOrder and LineItems Tables
- 3.2.6.2.1.4 PL/SQL Handler Code for a POST Request
- 3.2.6.2.1.5 Creating the REST API Service to Invoke the Handler
- 3.2.6.2.1.6 Defining the REST Service and Handler using PL/SQL API
- 3.2.6.2.2 Generating Nested JSON Objects from Hierachical Relational Data
- 3.2.6.2.3 Testing the RESTful Services
-
3.2.6.2.1
Inserting Nested JSON Objects into Relational Tables
- 3.2.7 About Working with Dates Using Oracle REST Data Services
- 3.3 Configuring Secure Access to RESTful Services
- 3.4 About Oracle REST Data Services User Roles
- 3.5 Authenticating Against WebLogic Server User Repositories
- 3.6 Integrating with Existing Group/Role Models
- 3.7 Using the Oracle REST Data Services PL/SQL API
- 3.8 Oracle REST Data Services Database Authentication
-
3.9
Overview of Pre-hook
Functions
- 3.9.1 Configuring the Pre-hook Function
- 3.9.2 Using a Pre-hook Function
- 3.9.3 Processing of a Request
- 3.9.4 Identity Assertion of a User
- 3.9.5 Aborting Processing of a Request
- 3.9.6 Ensuring Pre-hook is Executable
- 3.9.7 Exceptions Handling by Pre-hook Function
- 3.9.8 Pre-hook Function Efficiency
- 3.9.9 Pre-Hook Examples
- 3.10 Generating Hyperlinks
-
4
REST-Enabled SQL Service
- 4.1 REST-Enabled SQL Service Terminology
- 4.2 Configuring the REST-Enabled SQL Service
- 4.3 Using cURL with REST-Enabled SQL Service
- 4.4 Getting Started with the REST-Enabled SQL Service
- 4.5 REST-Enabled SQL Service Examples
- 4.6 REST-Enabled SQL Request and Response Specifications
- 4.7 Supported SQL, SQL*Plus, and SQLcl Statements
- 5 Migrating from mod_plsql to ORDS
-
6
Oracle REST Data Services PL/SQL Package Reference
- 6.1 ORDS.CREATE_ROLE
- 6.2 ORDS.CREATE_SERVICE
- 6.3 ORDS.DEFINE_HANDLER
- 6.4 ORDS.DEFINE_MODULE
- 6.5 ORDS.DEFINE_PARAMETER
- 6.6 ORDS.DEFINE_PRIVILEGE
- 6.7 ORDS.DEFINE_SERVICE
- 6.8 ORDS.DEFINE_TEMPLATE
- 6.9 ORDS.DELETE_MODULE
- 6.10 ORDS.DELETE_PRIVILEGE
- 6.11 ORDS.DELETE_ROLE
- 6.12 ORDS.DROP_REST_FOR_SCHEMA
- 6.13 ORDS.ENABLE_OBJECT
- 6.14 ORDS.ENABLE_SCHEMA
- 6.15 ORDS.PUBLISH_MODULE
- 6.16 ORDS.RENAME_MODULE
- 6.17 ORDS.RENAME_PRIVILEGE
- 6.18 ORDS.RENAME_ROLE
- 6.19 ORDS.SET_MODULE_ORIGINS_ALLOWED
- 6.20 ORDS.SET_URL_MAPPING
- 7 Oracle REST Data Services Administration PL/SQL Package Reference
-
8
Implicit Parameters
-
8.1
List of Implicit Parameters
- 8.1.1 About the :body parameter
- 8.1.2 About the :body_text Parameter
- 8.1.3 About the :content_type Parameter
- 8.1.4 About the :current_user Parameter
- 8.1.5 About the :status_code Parameter
- 8.1.6 About the :forward_location Parameter
-
8.1.7
About the Pagination Implicit Parameters
- 8.1.7.1 About the :page_offset Parameter
- 8.1.7.2 About the :page_size Parameter
- 8.1.7.3 About the :row_offset Parameter
- 8.1.7.4 About the :row_count Parameter
- 8.1.7.5 About the :fetch_offset Parameter
- 8.1.7.6 About the :fetch_size Parameter
- 8.1.7.7 About Automatic Pagination
- 8.1.7.8 About Manual Pagination
-
8.1
List of Implicit Parameters
- 9 OAUTH PL/SQL Package Reference
- 10 Enabling ORDS Database API
- A Oracle REST Data Services Third-Party License Information
- B Oracle REST Data Services Database Type Mappings
- C About the Oracle REST Data Services Configuration Files
- D Troubleshooting Oracle REST Data Services
-
E
Creating an Image Gallery
- E.1 Before You Begin
- E.2 Creating the Gallery Database Table
- E.3 Creating the Gallery RESTful Service Module
- E.4 Trying Out the Gallery RESTful Service
- E.5 Creating the Gallery Application
- E.6 Trying Out the Gallery Application
- E.7 Securing the Gallery RESTful Services
-
E.8
Accessing the RESTful Services from a Third Party Application
- E.8.1 Creating the Third Party Developer User
- E.8.2 Registering the Third Party Application
- E.8.3 Acquiring an Access Token
- E.8.4 Using an Access Token
- E.8.5 About Browser Origins
- E.8.6 Configuring a RESTful Service for Cross Origin Resource Sharing
- E.8.7 Acquiring a Token Using the Authorization Code Protocol Flow
- E.8.8 About Securing the Access Token
- Index