6.4 How to Access RESTful Services

Access RESTful Services from SQL Workshop.

Accessing RESTful Services
Access RESTful Services from the Workspace home page by clicking SQL Workshop and then RESTful Services.
Registering Schema with ORDS
If you are accessing ORDS Restful Services in a new workspace, you must register the schema with ORDS RESTful Data Services.
About ORDS RESTful Services Dashboard
Learn about ORDS RESTful Services dashboard.

Parent topic: Enabling Data Exchange with RESTful Services

6.4.1 Accessing RESTful Services

Access RESTful Services from the Workspace home page by clicking SQL Workshop and then RESTful Services.

To access RESTful Services:

If you are accessing ORDS Restful Services in a new workspace, you must register the schema with ORDS RESTful Data Services.

To register a schema with ORDS RESTful Data Services:

On the Workspace home page, click SQL Workshop.
Click RESTful Services.

The RESTful Services home page appears.
Click ORDS Based RESTful Services.

ORDS RESTful Services page appears. If your schema is not registered with ORDS RESTful Data Services, the following message appears.

Description of the illustration GUID-53DF5F00-2FCC-4710-858F-B2C4A8C9DF96-default.png
Click Register Schema with ORDS.

ORDS Schema Attributes dialog appears.

Description of the illustration GUID-E02FD29C-04FC-4DF3-B36D-BCBE52FD085E-default.png
Enter the attribute details:
1. Enable RESTful Access - Click Yes to enable or click No to disable the access to any REST services defined in the schema.
2. Schema Alias - Enter the name of the schema alias to be used in the formation of the URL referencing any RESTful service within the schema.
3. Install Sample Service - Click Yes or No. Clicking Yes installs sample oracle.example.hr RESTful service.
4. Authorization Required for Metadata Access - Click Yes or No. Clicking Yes requires Oracle REST Data Services user authorization before allowing access to the ORDS metadata catalog of the schema.
Click Save Schema Attributes.

ORDS RESTful page appears with a message Schema enabled for use with ORDS RESTful Services and sample RESTful Service successfully installed.

Parent topic: How to Access RESTful Services

Learn about ORDS RESTful Services dashboard.

Upon registering the schema with ORDS, the ORDS RESTful services page appears displaying the ORDS version.

The following table details the information available in the ORDS RESTful Services Dashboard:

Table 6-1 ORDS RESTful Services Dashboard Parameters

Name	Description
ORDS Version	Version of ORDS.
De- Register Schema from ORDS	Click to de-register schema.
Reset Sample Service	Click to reset the installed sample service.
Import	Click to import ORDS based RESTful service definitions from a SQL script generated by SQL Developer or Oracle Application Express.
Export	Click to export ORDS based RESTful Service metadata to SQL script file format.
Configure	Click to configure ORDS schema attributes.
Schema Access	Displays whether access to the RESTful services defined within the schema is enabled or disabled.
Metadata Access	Displays whether Oracle REST Data Services should require user authorization before allowing access to the ORDS metadata catalog of this schema.
Schema Aliased	Displays alias name for the current schema.
Modules	Displays total number of modules defined within the schema. Click to view list of defined modules.
Privileges	Displays total number of privileges defined. Click to view list of defined privileges.
Roles	Displays total number of roles associated. Click to view the associated roles.
Enabled Objects	Displays the total number of REST enabled database objects in the schema. Click to view list of REST enabled objects.
Module Status	Displays the status of published and unpublished modules.
Module Security	Displays the status of protected and unprotected modules.
Object Aliases	Displays the status of Aliased and Unaliased objects.

Parent topic: How to Access RESTful Services