7.6 Managing RESTful Service Modules
Learn how to install sample RESTful service module, You can create ,edit, and delete an ORDS RESTful service module.
A RESTful Service Module is a grouping of common templates, known as resource templates, under a common Uniform Resource Identifier (URI) prefix.
The specification of a URI prefix is optional. If defined for the RESTful Service Module, it is prepended to all resource templates. A priority value is used to choose between resource templates when their patterns both match a single request URI. In such cases, the resource template with the highest priority value is chosen.
- Installing a Sample RESTful Service Module with Schema ORDS not Enabled
Learn how to create a Sample RESTful Service Module with Schema ORDS not Enabled. - Installing a Sample RESTful Service Module with Schema ORDS Enabled
Learn how to create a Sample RESTful Service Module with Schema ORDS Enabled. - Creating an ORDS RESTful Service Module
Learn how to create an ORDS RESTful Service Module. - Editing an ORDS RESTful Service Module
An ORDS RESTful Service Module can have associated resource templates and resource handlers. During the edit process for a particular RESTful Service Module, you can make changes to any of the associated resource templates and resource handlers. - Deleting an ORDS RESTful Service Module
Deleting an ORDS RESTful service module removes the module along with all resource templates and resource handlers associated with this module. - Managing an ORDS RESTful Service Privileges
Privileges to access RESTful Service Modules can be restricted in APEX. - Assigning Privileges to an ORDS RESTful Service Modules
Learn how to assign privileges to an ORDS RESTful Service Modules. - Creating an ORDS RESTful Service Privilege
You can create an ORDS RESTful Service Privilege to restrict access to specified users for one or more RESTful Service Modules. - Editing an RESTful Service Privilege
You can modify an ORDS RESTful Service Privilege. Changes to the specified Protected Modules will be reflected in the Required Privilege setting on the RESTful Service Module page for affected modules. - Deleting an ORDS RESTful Service Privilege
You can remove an ORDS RESTful Service Privilege. After deleting the privilege, any RESTful Service Modules that were protected by this privilege will be unprotected until reassigned another privilege. - Exporting an ORDS RESTful Service Module
An ORDS RESTful Service Module metadata can be exported to a file in SQL script format. The exported file can be imported on the same instance or another compatible Oracle APEX instance. - Importing an ORDS RESTful Service Module
An ORDS RESTful Service Module metadata that has been exported to a file in SQL script format can be imported. The imported module must have been exported on the same instance or another compatible Oracle APEX instance. - Generating a Swagger Document
Learn how to generate a Swagger document.
Parent topic: Enabling Data Exchange with RESTful Services
7.6.1 Installing a Sample RESTful Service Module with Schema ORDS not Enabled
Learn how to create a Sample RESTful Service Module with Schema ORDS not Enabled.
Note:
You can install a sample RESTful service only when you create new workspace.
To create a Sample RESTful Service Module:
Parent topic: Managing RESTful Service Modules
7.6.2 Installing a Sample RESTful Service Module with Schema ORDS Enabled
Learn how to create a Sample RESTful Service Module with Schema ORDS Enabled.
Note:
You can install a sample RESTful service only when you create new workspace.
To create a Sample RESTful Service Module:
Parent topic: Managing RESTful Service Modules
7.6.3 Creating an ORDS RESTful Service Module
Learn how to create an ORDS RESTful Service Module.
To create an ORDS RESTful Service Module:
Parent topic: Managing RESTful Service Modules
7.6.4 Editing an ORDS RESTful Service Module
An ORDS RESTful Service Module can have associated resource templates and resource handlers. During the edit process for a particular RESTful Service Module, you can make changes to any of the associated resource templates and resource handlers.
To edit an ORDS RESTful Service Module:
7.6.5 Deleting an ORDS RESTful Service Module
Deleting an ORDS RESTful service module removes the module along with all resource templates and resource handlers associated with this module.
To delete an ORDS RESTful Service Module:
Parent topic: Managing RESTful Service Modules
7.6.6 Managing an ORDS RESTful Service Privileges
Privileges to access RESTful Service Modules can be restricted in APEX.
To protect an ORDS RESTful Service Modules by assigning privileges:
Parent topic: Managing RESTful Service Modules
7.6.7 Assigning Privileges to an ORDS RESTful Service Modules
Learn how to assign privileges to an ORDS RESTful Service Modules.
You can assign privileges to an ORDS RESTful Service Modules during the creation or editing of an ORDS RESTful Service Privilege, you can specify the module or modules protected by this privilege.
Note:
After a RESTful Service Privilege is deleted, all RESTful Service Modules protected by that privilege are unprotected.
7.6.8 Creating an ORDS RESTful Service Privilege
You can create an ORDS RESTful Service Privilege to restrict access to specified users for one or more RESTful Service Modules.
A RESTful Service Privilege can include users belonging to one or more user groups. RESTful Service Modules protected by this privilege display the privilege name for Required Privilege on the RESTful Service Module page.
To create an ORDS RESTful Service Privilege:
Parent topic: Managing RESTful Service Modules
7.6.9 Editing an RESTful Service Privilege
You can modify an ORDS RESTful Service Privilege. Changes to the specified Protected Modules will be reflected in the Required Privilege setting on the RESTful Service Module page for affected modules.
To edit a ORDS RESTful Service Privilege:
Parent topic: Managing RESTful Service Modules
7.6.10 Deleting an ORDS RESTful Service Privilege
You can remove an ORDS RESTful Service Privilege. After deleting the privilege, any RESTful Service Modules that were protected by this privilege will be unprotected until reassigned another privilege.
To delete an ORDS RESTful Service Privilege:
Parent topic: Managing RESTful Service Modules
7.6.11 Exporting an ORDS RESTful Service Module
An ORDS RESTful Service Module metadata can be exported to a file in SQL script format. The exported file can be imported on the same instance or another compatible Oracle APEX instance.
To export an ORDS RESTful Service module:
See Also:
Parent topic: Managing RESTful Service Modules
7.6.12 Importing an ORDS RESTful Service Module
An ORDS RESTful Service Module metadata that has been exported to a file in SQL script format can be imported. The imported module must have been exported on the same instance or another compatible Oracle APEX instance.
Note:
If the imported module contains a ORDS RESTful Service name that exists in this workspace, the existing ORDS RESTful Service is deleted and replaced with the definition from the imported module.To import an ORDS RESTful Service module:
Parent topic: Managing RESTful Service Modules
7.6.13 Generating a Swagger Document
Learn how to generate a Swagger document.
Generate a swagger document by setting up the URL at the Oracle APEX instance level. This allows you to define the URL for a Swagger server. Oracle APEX sends generated swagger document to the server for rendering when the URL is setup at the instance level. Oracle APEX just displays the JSON generated for Swagger when the URL is not specified.
To generate a Swagger a document:
Parent topic: Managing RESTful Service Modules