6.3 RESTful Service Requirements

Outlines the requirements for exposing RESTful services to external systems.

To provide RESTful services from within Oracle Application Express, you must have Oracle REST Data Services release 2.0 or later as your web listener and enabled RESTful Services either at the workspace or instance-level by an administrator.

In order for the RESTful Service utility to be available and function properly, the following requirements must be met:

  • Your configuration uses Oracle REST Data Services release 2.0 or later as your web listener.

  • An administrator has enabled RESTful Services either at the workspace or instance-level.

  • The Oracle REST Data Services version 2.0 or higher must be used.

    Tip:

    The Oracle XML DB HTTP Server with the embedded PL/SQL gateway and Oracle HTTP Server with mod_plsql do not support RESTful Services.

Versions of Oracle Application Express prior to 18.1 maintains the metadata about APEX based RESTful Services defined in the core Oracle Application Express metadata repository.

As Oracle moves toward a unified RESTful Services repository based on Oracle REST Data Services (ORDS), you need to allow for migration of RESTful Services previously defined in Application Express to the ORDS based repository.

Oracle Application Express release 18.1 requires Oracle REST Data Services release 17.4.1 or later to provide full integration with the ORDS Metadata repository. Functionality of the REST Services section of Application Express provides for the following scenarios.

  • When running Oracle Application Express release 18.1 with a version Oracle REST Data Services prior to release 17.4.1, only the traditional Oracle Application Express based REST Services console is available. You can continue to create and maintain Oracle Application Express based RESTful services and they will be stored in the traditional Oracle Application Express metadata repository.

  • When running Oracle Application Express release18.1 with a version of Oracle REST Data Services release 17.4.1 or later and the workspace currently contains Oracle Application Express based RESTful services.

    • You will be given read-only access to the traditional Oracle Application Express based RESTful Service pages. The current services continue to work , however, you are not be able to create new or edit existing Application Express based RESTful services.

    • Clicking Migrate to ORDS RESTful Services button migrates all existing Oracle Application Express based RESTful services within the workspace to the ORDS metadata repository.

  • When running Oracle Application Express release 18.1 with a version of Oracle REST Data Services release 17.4.1 or later and the workspace currently does not contain any Oracle Application Express based RESTFUL services, you are navigated to the new Oracle REST Data Services (ORDS) Based Restful Services pages and will not have access to the traditional Oracle Application Express based RESTful services screens.