Previous Next JavaScript must be enabled to correctly display this content

## 7 Enabling Data Exchange with RESTful Services

RESTful Services enable the declarative specification of RESTful services used to access the database.

Note:

The ability to define REST APIs using RESTful Services in SQL Workshop is deprecated with Oracle APEX 26.1 and will be removed in a future release of APEX. The declarative specification of REST APIs remains supported in SQL Developer Web.

RESTful Services enable the creation of a set of standards-based APIs on top of database objects available for a workspace. Without connecting directly to the underlying data source, these APIs enable external systems to interact securely with the data by querying, inserting, updating, or deleting.

The definitions of RESTful services created within Oracle APEX are stored in the Oracle REST Data Services (ORDS) repository, and are referred to as ORDS-based REST Services.

Note:

Prior to release 18.1, the definitions of RESTful services created within APEX were stored within the metadata tables of the core APEX schema. They were referred to as APEX-based REST Services. APEX-based REST Services were desupported in APEX release 22.1.

ORDS release 21.4.2 and later includes migration scripts that enable you to upgrade any remaining APEX-based REST Services to ORDS-based Services. To learn more, see Migration of Oracle APEX Restful Service Modules in Oracle REST Data Services Release Notes.

This section introduces you to the concepts of RESTful services and describes how to create, edit, and delete RESTful Services using APEX.

Note:

Your workspace administrator controls whether RESTful services are enabled. If disabled, the RESTful Services icon does not display.

- About Oracle RESTful Services in Oracle APEX
  This section introduces RESTful Services as implemented by Oracle REST Data Services (ORDS) and provides clarification on the terminology used within APEX and other Oracle tools to reference the different components that make up a RESTful Service.
- Enabling REST Objects
  Enable REST objects using the AutoREST feature of ORDS.
- Enabling Authorization for REST-enabled Objects
  Restrict access for REST-enabled objects on the RESTful Services page. Use the resulting Authorization Role information to configure user roles in ORDS.
- How to Access RESTful Services
  Access RESTful Services from SQL Workshop.
- How to Create the ORDS Based RESTful Services Module Example
  Learn how to create the ORDS Based RESTful Services module example.
- Managing RESTful Service Modules
  Learn how to install sample RESTful service module, You can create ,edit, and delete an ORDS RESTful service module.
- Managing Resource Templates
  Resource templates are a means of grouping URIs and associating them with a particular RESTful Service Module.
- Managing Resource Handlers
  A resource handler is a query or an anonymous PL/SQL block responsible for handling a particular HTTP method.
- Accessing SQL Developer Web Directly from APEX
  Access SQL Developer Web from the SQL Workshop menu.

See Also:

Enabling RESTful Services and Defining a Path Prefix for a Workspace in Oracle APEX Administration Guide