A Primer on Oracle E-Business Suite REST Services

Oracle E-Business Suite Integrated SOA Gateway (ISG) was introduced in E-Business Suite (EBS) Release 12.1, as an infrastructure to provide and consume SOAP based Web Services. In EBS R12.2.3, ISG is enhanced to provide REST-based Web Services. 

What is REST?

REST stands for Representational State Transfer. It is an architectural style for distributed hypermedia systems. The term REST was introduced and described by Roy Fielding in 2000, in his doctoral dissertation - Architectural Styles and the Design of Network-based Software Architectures. This REST architectural style may be applied to web services. Note that REST is not a standard and its implementation often varies to suit application needs.

Using a PL/SQL API as a REST Service

E-Business Suite public PL/SQL APIs can be deployed as REST-based Web Services from the E-Business Suite's Integration Repository. One or more methods of the API can be selected to be exposed as functionally-secure REST resources. Each of these resources can be identified by an URI. These resources can then be manipulated by making HTTP request to the URI. As of R12.2.3, ISG supports POST HTTP Verb for REST Services. This feature is also available for custom PL/SQL APIs registered in the Integration Repository. 

PL/SQL REST screenshot

Unlike EBS SOAP Services, REST Services are deployed in EBS’s OAFM Managed Server. These REST Services do not depend on external Fusion Middleware components like Oracle SOA Suite. These are simple, lightweight REST Services suited for UI integrations and mobile applications.

Key features of EBS REST Services

  • Supports POST HTTP Verb
  • Supports XML and JSON message format
  • Described in WADL, XSDs
  • Supports HTTP Basic and Token based Authentication
  • Predeployed EBS Security Services 

EBS Security Services

EBS Security Services are a special group of predeployed REST services that provide authentication and authorization for EBS users. These include:

  • Login and Logout Service
  • Application Context Initialize & Retrieval Service
  • Access Control Service 

Security service screenshot

You can search for these services by selecting ‘Interface Subtype’ as Category and ‘Security Services’ as Category Value in More Search Options region as shown above.

I am looking forward to hear your feedback on Integrated SOA Gateway and REST Services. You can mail me at Rekha Ayothi Oracle email ID


Related Articles


I've been trying to promote the adopt of Web Services in my company (mostly in our Product Development area) but the complex installation requirements for using ISG have been one of the main reasons that upper management and some clients haven't given it a chance yet.

Do you have any document or step-by-step tutorial on how to install ISG on 12.2.3? I've been trying to follow Metalink Note Note 1311068.1 but the process has been quite (and unpopular) painful so far.



Posted by Fede on May 19, 2014 at 10:36 AM PDT #

Hi Rekha,

Thank you for the article 'A Primer on Oracle E-Business Suite REST Services' very useful info for EBS customers assessing their application integration options with EBS R12.

With regard to mobile enablement of EBS R12 applications (HR, Financials, Purchasing, etc) accessible from mobile devices (Android, iOS), can Oracle provide any guidance on the following items:-

1. Is Oracle planning to release a JRE free version of Oracle EBS, accessible from any browser enabled client? If so, is there a roadmap available for its delivery?
2. A US company called Apogee are scheduled to release their JRE4A product (http://www.apogee.com/products/cjre-a) in June 2014, the purpose of which is to allow the running of standard Java SE applications and other Java SE software (games, for example) on Android-based devices, such as smart phones, tablets, and other "hand-helds". Can Oracle confirm if they are aware of the JRE4A product and whether / when they intend to certify and thus support their JRE dependent products, particularly EBS, against this product?
3. In the event items 1 & 2 are not applicable to EBS, can Oracle confirm what additional Oracle software would be required in order to make EBS R12.2.3 application functionality / data accessible to Android / iOS based mobile devices? We are currently upgrading our EBS instances to EBS R12.1.3

Any assistance you can provide will be greatly appreciated.


Andy Clark
Application Architect

Posted by guest on May 20, 2014 at 05:40 AM PDT #

Hello, Andy,

I've sent you a private email, as well.

1. No, we expect that the E-Business Suite will continue to have Forms-based content for the foreseeable future. That content will continue to run in Java.

2. We have no plans to certify any third-party Java-compatibility products with the E-Business Suite.

3. Forms-based modules in the E-Business Suite will be certified only with clients that are capable of running Oracle’s JRE plug-in.


Posted by Steven Chan on May 20, 2014 at 10:14 AM PDT #

Hello Steve & Rekha,

As I understand the usage of REST services as described above will only work in EBS 12.2.3. What about the customers with 12.1.3, or even with 11i. Are there any suggested best practices or guidelines?


Posted by Ramesh on June 01, 2014 at 06:38 AM PDT #

Hi Ramesh,

Yes, as of now, this feature is available in most recent release EBS R12.2.3. For earlier releases such as EBS R12.1.3, customers may use SOAP Services provided by Integrated SOA Gateway. For EBS 11i, customers may use Oracle Applications Adapter from Fusion Middleware.

Let me know if you have requirement for EBS REST Services in EBS R12.1.3. Please file Enhancement Request in My Oracle Support and, forward me the SR number.


Posted by Rekha Ayothi on June 02, 2014 at 05:23 AM PDT #

Hi Rekha,

We are in 12.1.3 and looking for security webservices so that we can authenticate our other applications with security services.

Does 12.1.3 has any equivalent REST or SOAP authentication webservices.


Posted by Benjamin Bharavi on June 05, 2014 at 12:44 AM PDT #

Hi Benjamin,

No, as of now, these authentication services are available in R12.2.3. Have you explored, EBS SDK for Java. It provides JAAS based APIs to authenticate EBS users from external application.

If you are strictly looking for REST or SOAP security services in R12.1.3, please file a formal enhancement request in My Oracle Support. And, mail me the SR number.


Posted by Rekha Ayothi on June 06, 2014 at 05:53 AM PDT #

Dear Rekha,
Thanks for the post. If we have only core licenses...such as Oracle Financial licenses only..then do we need any additional licenses to leverage this feature?

Posted by Hrishi on August 15, 2014 at 10:28 AM PDT #


We're in Development and are not really qualified to discuss licensing terms. I'd recommend that you contact your Oracle account manager to discuss this further.


Posted by Steven Chan on August 18, 2014 at 11:22 AM PDT #

Is the future roadmap for XML Gateway to use RESTful services as an option in Integrated SOA Gateway (ISG) starting with Oracle EBS r12.2.3?

Posted by kc on November 06, 2014 at 07:00 AM PST #

Hi KC,

This blog talks about fine grained REST Services that work on business objects. These are more likely to be used in mobile, UI and A2A integrations.

XML Gateway provides an infrastructure for XML based B2B integrations with trading partners. B2B integrations are much more than RESTful calls - it involves trading partner management, code conversions, business standards like OAG, etc. As of today, XML Gateway provides XML over HTTP, SOAP, JMS communication methods. In future, we may have REST communication method as well.

Hope that helps,

Posted by Rekha Ayothi on November 07, 2014 at 09:20 PM PST #

If I wanted to create an IOS mobile app to read information from an Enterprise Oracle Retail Management System, would I use the Oracle E-Business Suite REST Services as described in this article?

Posted by guest on January 16, 2015 at 09:32 AM PST #

Dear Guest,

This blog article talks about Oracle E-Business Suite Integrated SOA Gateway (ISG). ISG is part of Oracle E-Business Suite. Oracle E-Business Suite and Oracle Retail are different application suites. You may have to refer Oracle Retail documentation for REST Services published by Oracle Retail applications.


Posted by Rekha Ayothi on January 19, 2015 at 01:59 AM PST #

We are on 12.1.3. And I understand RESTful for ISG is currently supported for 12.2 only. Is it NOT possible to deploy a RESTful webservice developed using say Jersey on a 12.1.3 OC4J instance? After all OC4J is a servlet container and with all libraries deployed and Jersey servlet configured, is it NOT possible to deploy RESTful services even on 12.1.3 instance? Could you please clarify the same.

With regards,
Veerendra S.

Posted by guest on January 22, 2015 at 08:14 AM PST #

Post a Comment:
  • HTML Syntax: NOT allowed


« March 2015