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.
Learn how to create a Sample RESTful Service Module.
Note:
You can install a sample RESTful service only when you create new workspace.
To create a Sample RESTful Service Module:
Learn how to create a RESTful Service Module.
To create a RESTful Service Module:
A 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 a RESTful Service Module:
On the Workspace home page, click SQL Workshop and then RESTful Services.
The RESTful Services home page appears.
Click the name of the module you want to edit.
The RESTful Service Module edit page appears.
Note:
Use the RESTful Service tree on the left pane to view, edit and create resource templates and resource handlers.
To edit RESTful Service Module settings, make changes to the fields on the right pane under RESTful Services Module.
To edit a resource template:
Select the resource template you want to edit on the RESTful Service tree on the left panel. The resource template options appear on the right panel.
Make your changes.
Click Apply Changes.
To edit a resource handler:
Select the resource handler you want to edit on the RESTful Service tree. The resource handler options appear on the right panel.
Make your changes.
Click Apply Changes.
Click Apply Changes.
Deleting a RESTful service module removes the module along with all resource templates and resource handlers associated with this module.
To delete a RESTful Service Module:
Privileges to access RESTful Service Modules can be restricted to Application Express users that belong to an Application Express user group.
To protect RESTful Service Modules by assigning RESTful Service Privileges:
Learn how to assign privileges to RESTful Service Modules.
There are a couple of ways to assign privileges to RESTful Service Modules:
During the creation or editing of a RESTful Service Module, you can specify the privilege for the module.
During the creation or editing of a 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.
You can create a 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 a RESTful Service Privilege:
You can modify a 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 RESTful Service Privilege:
You can remove a 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 a RESTful Service Privilege:
RESTful Service Module meta data can be exported to a file in SQL script format. The exported file can be imported on the same instance or another compatible instance of Application Express.
To export a RESTful Service module:
See Also:
RESTful Service Module meta data 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 instance of Application Express.
Note:
If the imported module contains a RESTful Service name that exists in this workspace, the existing RESTful Service is deleted and replaced with the definition from the imported module.
To import a RESTful Service module:
See Also: