X

Announcements and Technical Advice for the Oracle
Utilities product community from the Product Management team

  • October 28, 2019

REST URI Customization

Anthony Shorten
Senior Principal Product Manager

One of the key changes in the latest Oracle Utilities Application Framework (4.4.0.2.0) is the ability to influence the URI used to access the REST API's in the product. This is a combination of some key environmental parameters and parameters on the service itself.

{http_verb} https://{base_uri}/{owner}/{category}/{service_uri}/{operation_uri}/{data}

Where:

Component Usage Comments
{http_verb} Sets the verb used to access the service. Oracle Utilities Application Framework supports GET, POST, UPDATE and PATCH. POST should be used for Business Service and Service Script based operations
{base_uri} Base Level URI. There are two possible values:
  • Autogenerated. This is the default for most installs.
  • Environment Variable. Uses the value of the CLOUD_LOCATION_F1_BASE_REST_URL
Autogeneration uses:

https://{host}:{port}/{context}/rest/apis/

{owner} Owner code for record. cm is used for custom services. Uses F1-RESTOwnerURLComponent Extended Lookup
{category} Resource category Uses F1-RESTResourceCategory Extended Lookup
{service_uri} Service Level URI This is configured on the REST Inbound Web Service at the service level
{operation_uri} Operation Level URI This is configured on the REST Inbound Web Service at the operation level
{data} Query or embedded parameters for REST call This is configured on the REST Inbound Web Service at the operation level

Here is an example:

URI Configuration

In the REST specification the provision of parameters can be in the payload (default), embedded in the URI (for simple parameters) and as a query on the URI (for multiple parameters). This capability can be configured at the operation level. The capability allows for the specification of the parameter appearing on the URL, the method supported and the mapping to the underlying schema for the parameter. For example:

URI Parameters

 

For more information about REST and other Web Service capabilities, refer to the online documentation and Web Services Best Practices (Doc Id: 2214375.1) available from My Oracle Support.

 

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.