If a selected interface can be exposed as a REST service, you can find the REST Web Service tab included in the interface details page. It can be an interface type of PL/SQL, Concurrent Program, Java Bean Services, or Application Module Services.
An integration administrator can click Deploy to deploy selected operations contained in the API as REST service operations. Once the REST service has been successfully deployed, the REST Service Status field is changed from 'Not Deployed' to 'Deployed'.
The following fields are common in the REST Web Service tab:
| Field | Description |
|---|---|
| Service Alias | Each REST service should be associated with a unique alias name. Before deploying a REST service, the administrator must enter this field which will be used in service endpoint, WADL, XSDs, and namespaces. Please note the following guidelines when specifying the service alias:
|
| REST Service Status | This field indicates different state of a REST service during service life cycle.
In addition to 'Not Deployed' and 'Deployed' service states, more intermediate service statuses can be shown while the service is in the process of performing an action issued by the administrator and transforming to a different state. The following list describes intermediate service status information:
|
| View WADL | This link is displayed after the selected interface has an associated REST service deployed. Click this link letting you review WADL description for the deployed REST service. This field appears only when the REST service has been successfully deployed with 'Deployed' status. See: Reviewing Web Service WADL Source. |
| Verb | The Verb value indicates how the REST service is implemented using an HTTP method. If the selected interface is a PL/SQL API or Concurrent Program, then this field is displayed when the REST service has the Deployed status. Please note that POST is the only supported HTTP method for PL/SQL APIs and Concurrent Programs. |
| REST Service Security | To secure REST service content, all REST services are secured by either one of the following security methods:
|
| Service Operations table | This table displays the list of procedures or functions contained in the selected interface that can be exposed as REST service operations. For more information on each field in the table, see Service Operations Table. |
The Service Operations table displays each method (or procedure or function) contained in the selected interface, and whether it is exposed as a service operation. Users who have the Integration Administrator role can perform administrative tasks including deploying or undeploying services with desired service operations as well as creating or revoking security grants.
The following table describes each field in the Service Operations table:
| Field | Description |
|---|---|
| Select | Users who have the Integration Administrator role can select one or more methods from the table before deploying the service. |
| Display Name | This is the interface name used externally. |
| Internal Name | This is the interface name used internally. |
| Included Operations (PL/SQL APIs and Concurrent Programs Only) | This column is displayed when the selected PL/SQL API or Concurrent Program has been exposed as a REST service. A "check" icon is displayed in this column for the method or operation that has been exposed as a REST service operation.
Note: Since each concurrent program contains only one method, there is no need to select a desired method before deploying it as a REST service. The method contained in the concurrent program will be automatically deployed as a REST service operation with POST HTTP method by default. |
| GET (Java Bean Services and Application Module Services Only) |
This GET HTTP method column is displayed when the selected interface is an interface type of Java Bean Services or Application Module Services.
This GET check box is preselected if a Java or an Application Module method is annotated with the GET HTTP method. The administrator can uncheck the preselected GET check box for the Java or Application Module method if it will not be published with the GET method. However, if the GET method is not annotated, unlike the POST method, the GET check box becomes inactive or disabled for further selection. |
| POST (Java Bean Services and Application Module Services Only) |
This HTTP method column is displayed when the selected interface is an interface type of Java Bean Services or Application Module Services. Similar to the GET method for Java Bean Services and Application Module Services, this POST check box is preselected if a Java or an Application Module method is annotated with the POST HTTP method. The administrator can uncheck the preselected check box before deploying the service if the Java or Application Module method will not be published with the POST method. If the POST HTTP method is not annotated, the POST check box remains active or enabled by default. This allows the administrator to select the POST check box if needed for the Java or Application Module method as a REST service operation before service deployment. |
| Grant | If the access permission of an operation has been granted to a specific user, user groups, or all users, then the Grant icon is displayed for the operation. Only users who have the Integration Administrator role and the Integration Developer role can find the Grant icon and view the grant details. |
Performing Administrative Activities for REST Web Services
REST services have a simplified service development life cycle. Users who have the Integration Administrator role can perform the following administrative tasks in the interface details page:
Note: For information about different user roles and their associated privileges to administer and view REST services, see Accessing Oracle Integration Repository.
Deploy (REST Web Service tab): This allows an integration administrator to deploy the REST service.
Before deploying the service, an integration administrator must enter a unique name in the Service Alias field and select desired service operations. If the selected interface is an interface type of Java Bean Services or Application Module Services, choose the desired HTTP method check boxes for the Java or Application Module methods to be exposed as REST service operations.
Once the REST service has been successfully deployed, the service status is changed to 'Deployed'. This indicates that this deployed service is ready to be invoked and accept new service requests.
For more REST service deployment information, see Deploying REST Web Services.
Undeploy (REST Web Service tab): This action not only undeploys the service from an Oracle E-Business Suite managed server to the Integration Repository, but also resets its status to the initial state 'Not Deployed'.
For more REST service undeployment information, see Undeploying REST Web Services.
Create Grant (Grants tab): The administrator selects desired service operations before clicking Create Grant. The Create Grants page appears where grants can be created for a user, a user group, or all users.
The administrator selects desired service operations and clicks Revoke Grant. This opens the Revoke Grants page where the administrator can remove existing grants from an authorized user, a user group, or all users.
The grant feature applies to both SOAP and REST services. For more information on security grants, see Managing Grants.