Enabling Data Exchange with REST APIs

Note: The ability to define REST APIs using RESTful Services in SQL Workshop is removed with Oracle APEX 26.2. The declarative specification of REST APIs remains supported in SQL Developer Web.

Managing Schema REST Access for SQL Developer Web

To manage schema REST access for SQL Developer Web:

  1. From the workspace home page, select SQL Workshop, then SQL Developer Web.

    APEX displays the SQL Developer Web schema list, which contains the assigned workspace schemas that the current developer is authorized to access.

  2. For a REST-enabled schema:

    1. Select the schema name to open it in SQL Developer Web.
    2. Select Configure to open the ORDS Schema Attributes dialog.

  3. For a schema that is not REST-enabled, select Enable to open the ORDS Schema Attributes dialog and configure the attributes:

    1. Enable RESTful Access — Enables or disables ORDS access for the schema. Disabling access does not delete existing ORDS metadata or REST services.
    2. Schema Alias — The alias used for the schema in ORDS URLs. A schema must be REST-enabled before it can be opened in SQL Developer Web.
    3. Authorization Required — Controls whether ORDS requires authorization to access the schema’s ORDS metadata/API catalog.

  4. Save the changes and return to the schema list. Once the schema is enabled, you can open it in SQL Developer Web.

Accessing SQL Developer Web Directly from APEX

Access SQL Developer Web from the SQL Workshop menu.

SQL Developer Web (also known as Database Actions) provides a web-based interface that enables you to execute queries and scripts, create database objects, load data, build data models, and monitor database performance.

Users with Developer rights and access to SQL Workshop can open a SQL Developer Web session for any database schema associated with the current workspace directly from APEX using the SQL Developer Web option on the SQL Workshop menu in the menu bar.

Requirements for enabling the SQL Developer Web menu option include:

To open a SQL Developer Web session from APEX:

  1. Select the Enable SQL Developer Web attribute in Administration Services:

    1. Sign in to APEX Administration Services.

    2. Click Manage Instance.

    3. Under Instance Settings, click Feature Configuration.

    4. Locate the SQL Workshop section and select Enable SQL Developer Web.

    5. Sign out of Administration Services.

  2. Sign in to your APEX workspace.

  3. Click the SQL Workshop menu.

    Note the SQL Workshop menu now includes a SQL Developer Web menu option.

    Description of image follows

    Description of the illustration sql_developer_web.png

  4. Click the SQL Developer Web menu:

    • If there is only one schema associated with the current workspace and that schema already is REST-enabled, select the schema name to open it in SQL Developer Web.

    • If there are multiple schemas associated with the current workspace, a dialog displays showing the schemas and indicating whether they are REST-enabled.

      Note: Opening a new browser tab with SQL Developer Web invalidates and ends any other open SQL Developer Web sessions for the that browser.

For a schema that is not REST-enabled, select Enable to open the ORDS Schema Attributes dialog where you can choose to REST-enable a schema. Once the schema is REST-enabled, you can select it to open a SQL Developer Web session in a new browser tab.

Related Resources

For more information, see: