17.3.4 Example: Creating a REST Enabled SQL Service Reference

Review an example of creating REST Enabled SQL service reference on a remote database.

The following example builds a fictional REST Enabled SQL service reference named SCOTT_OBE Example using the Base URL http://server.example.com:8080/ords/scott_obe.


Before creating a REST enabled SQL reference, developers must complete the requirements described in "Before You Begin: REST Enabled SQL Service Requirements".

To create a REST Enabled SQL service reference:

  1. Navigate to the REST Enabled SQL page:
    1. On the Workspace home page, click App Builder.
    2. Select an existing application.
    3. On the Application home page, click Shared Components in the center of the page.
    4. Under Data Sources (bottom left of the page) select REST Enabled SQL.
  2. On the REST Enabled SQL page, click Create.
  3. On General, specify:
    1. Name - Enter a descriptive name for this REST Enabled SQL service. For example: SCOTT_OBE Example.
    2. Endpoint URL - Enter the base URL for this REST Enabled SQL service. For example: http://server.example.com:8080/ords/scott_obe
    3. Click Next.
  4. For Authentication, specify the appropriate credentials:
    1. Credentials - Select an existing credential to authenticate against. For example: To create new credentials, select Enter New.
    2. Credential Name - Enter a descriptive name for the credentials. For example: SCOTT_OBE Credentials.
    3. Authentication Type - Specify the Authentication type. For example: Basic Authentication.
    4. Client ID - Enter the database user name. For example: SCOTT_OBE.
      User names for Basic Authentication are converted to upper case. To include a case-sensitive user name, prefix it with the exclamation mark (!).
    5. Client Secret - Enter the database user name.
    6. Verify Client Secret - Enter the password.
  5. Click Create.

    Oracle Application Express tests the REST Enabled SQL service. If everything has been done correctly (that is, you have included the correct URL, schema name, and password), the Test REST Enabled SQL Service message appears as shown in the following illustration.Description of test_rest_enabled_ref1.png follows
    Description of the illustration test_rest_enabled_ref1.png

  6. Click Close.
The REST Enabled SQL service appears on the REST Enabled SQL page.