1. <ProductName> REST APIOracle REST Data Services API
  2. Quick Start

Quick Start

.

Step 1: Install and configure Oracle REST Data Services

The Data Dictionary, Environment, General, Monitoring, Performance, and Pluggable Database Lifecycle Management endpoints are delivered by Oracle REST Data Services (ORDS). ORDS is included in your Oracle Database installation, and is located at in the ORDS directory at $ORACLE_HOME.

Perform the following tasks before you use the endpoints provided by ORDS:

  1. Install ORDS: To install and configure ORDS, refer to Configuring and Installing Oracle REST Data Services.
  2. Enable the Database REST API: By default, the ORDS database API feature is disabled when you install ORDS for the first time. To enable the Oracle REST Data Services (ORDS) Database API, refer to Enabling ORDS Database API.
  3. Starting ORDS in Standalone Mode: To launch Oracle REST Data Services in standalone mode, refer to Running in Standalone Mode .
  4. REST Enable a SCHEMA: You must REST-enable the Oracle database schema on which you want to use the REST- Enabled SQL service, refer to REST-Enabling the Oracle Database Schema. Ensure that the administrator schema is ORDS enabled and is granted with the DBA or DBA and PDB_DBA roles.

When you are accessing the ORDS endpoints, provide the rest enabled schema user credentials, along with associated database account password.

ORDS can be downloaded as a separate product from Oracle REST Data Services Downloads.

Step 2: Install cURL

The examples used in this document use the cURL command-line tool to demonstrate how to access the Oracle Database REST API. To connect securely to the REST server, you must install a version of cURL that supports SSL

To install cURL on your system:

  1. In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the navigation menu.

  2. On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system. Click the link to download the ZIP file, and extract the executable to the desired folder.

When running cURL from a Windows command shell only, you must provide an SSL certificate authority (CA) file or bundle to authenticate against the Verisign CS certificate.

  1. Navigate to the cURL CA Extract page at http://curl.haxx.se/docs/caextract.html and download the cacert.pem SSL CA certificate file in the folder where you installed cURL.

  2. Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of the SSL CA certificate file. For example, on a Windows system you would enter:

    C:\curl> set CURL_CA_BUNDLE=cacert.pem

You are now ready to send REST requests to the Database REST API instance using cURL. See Authentication, and Use cURL.