The Latest Oracle E-Business Suite Technology News direct from
Oracle E-Business Suite Development & Product Management

A Primer on Oracle E-Business Suite REST Services

Rekha Ayothi
Product Management

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


Join the discussion

Comments ( 41 )
  • Fede Monday, May 19, 2014

    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.



  • guest Tuesday, May 20, 2014

    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:-


    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?


    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?


    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

  • Steven Chan Tuesday, May 20, 2014

    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.



  • Ramesh Sunday, June 1, 2014

    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?



  • Rekha Ayothi Monday, June 2, 2014

    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.



  • Benjamin Bharavi Thursday, June 5, 2014

    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.



  • Rekha Ayothi Friday, June 6, 2014

    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.



  • Hrishi Friday, August 15, 2014

    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?



  • Steven Chan Monday, August 18, 2014


    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.



  • kc Thursday, November 6, 2014

    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?

  • Rekha Ayothi Saturday, November 8, 2014

    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,



  • guest Friday, January 16, 2015

    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?

  • Rekha Ayothi Monday, January 19, 2015

    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.



  • guest Thursday, January 22, 2015


    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.

  • guest Monday, May 11, 2015


    I m consuming REST API from oracle PlSQL, M stucked in passing parameter, REST api is accepting param throgh POST Method.

    can u guide me though any working example.. on how to call parameterized (POST) rest API from oracle PL SQL.


  • Rekha Ayothi Friday, May 15, 2015

    Dear Guest,

    I am not sure if your query is with respect to E-Business Suite or in general, Oracle PL/SQL. If it is former, then please file enhancement request in My Oracle Support and forward me the Service Request number. If it is the latter case, I am afraid - this forum caters to Oracle E-Business Suite technology, you may have to try different forum.



  • guest Monday, August 3, 2015

    Hi Steven,

    I am mew to this ISG. I have just started exploring it. Can you please let me know of any start up guide for me to implement a custom pl/sql package as webservice through ISG. I also do not see the Gnerate WSDL button also under my ISG responsibility. I have assigned teh user 'IREP Adminstartor role'.

    Thanks in advance.

  • Rekha Ayothi Monday, August 3, 2015

    Dear Guest,

    Here are few resources for reference:

    - Tutorial: Publishing EBS 12.2 PL/SQL APIs as REST Services


    - Creating custom integration interfaces


    - Administering custom integration interfaces


    'Generate' button is available only for EBS users with Integration Repository Administrator role. Refer:




  • Pradosh Thursday, August 6, 2015

    Hi Rekha,

    In EBS 12.2.3 version EBS interfaces can be exposed as RESTful services. I went through the Developer Guide , Implementation Guide and User Guide , but couldn't find how to Invoke/Consume a external RESTful web service from EBS .

    Is it supported in ISG ? Any other way to consume/Invoke RESTful web service from EBS?



  • Rekha Ayothi Monday, August 10, 2015

    Hi Pradosh,

    As of today, ISG let's one invoke and consume SOAP based web services only. Please file Enhancement Request in My Oracle Support for an ability to invoke REST based web services from ISG.



  • Steve Thursday, September 3, 2015

    We are using Oracle CRM On Demand and Oracle e-Business Suite (12.1.3). Would it be possible to send datafrom Oracle CRM On Demand to Oracle e-Business utilizing RESTful services?

  • Rekha Ayothi Friday, September 4, 2015

    Hi Steve,

    With recent update, one can publish Oracle E-Business Suite public APIs as REST services in R12.1.3. Please refer My Oracle Support Document 1998019.1 - Oracle E-Business Suite Integrated SOA Gateway 12.1.3 REST Services Update.

    Now coming to your question on Oracle CRM On Demand: I am afraid, I may not be able to speak for Oracle CRM On Demand, you may want to check with your Account Manager for contact.



  • guest Saturday, September 12, 2015

    Is there any security issue if we are invoking ebs APIs using DB adapter from Oracle SOA Suite.

    We also have a need to fetch data directly from tables/views from EBS via Oracle SOA suite. What is the best way to do it?

  • Janak Wednesday, October 7, 2015

    Hello Rekha,

    I want to create REST_JAVA service type function from Functional Admin role but not able to find any useful details regarding steps to create class which I need to assign to HTML Call.

    I have read from oracle docs that we can use REST_JAVA Service using following url:


    Can you please help me how to create this function, steps to create java class/jsp which we can use in function?

    Warm regards,


  • guest Friday, October 30, 2015

    Hi Steve,

    We are planning to upgrade EBS12.1 to 12.2,the APP Tier is mutilple nodes, currently we are using GFS filesystem for the shared appl_top, common_top and logs(requests), due to too many transactions, there are lot of performance issues with the filesystem, so we are trying to replace teh GFS with OCFS2 for the shared filessytem like logs/requests in EBS12.2.can you please let me know what is the minimun requirmement(requested from our network team) for input/output per second?

    Also, what filessytem you recommand to use for the shared filesystem ? is OCFS2 A good choice?

    thanks a lot!


  • Robert Friday, November 13, 2015

    Hi Rekha

    I have used REST services in 12.2.4 and are now attempting to use the backported version in 12.1.3.

    Following all documentation we can only get it to work for simple parameters. As soon as we use RECORDS or COLLECTIONS as out parameters in PLSQL we simply get a “ISG_SERVICE_EXECUTION_ERROR” response with nothing of note in log files.

    This all works perfectly in 12.2.4. Can you confirm that it is supported in 12.1.3 and if there are any pointers as to an issue?



  • Rekha Ayothi Monday, November 16, 2015

    Hi Robert,

    I am sorry to hear that you are facing this issue. Please file a Service Request in My Oracle Support. One of our Support Engineers will assist you.

    Also, feel free to drop me a mail with SR number, if it is stuck in the process.



  • guest Friday, November 27, 2015


    I need to provision users on various oracle application like oracle financials , oracle crm etc through java code. What could be the best way and where can I find Webservices published by these apps

  • Simon Rastello Thursday, February 4, 2016

    Hi Rekha,

    Thanks for your very useful article !

    We are facing the same problem as Robert : "As soon as we use RECORDS or COLLECTIONS as out parameters in PLSQL we simply get a ISG_SERVICE_EXECUTION_ERROR" with the same EBS version (12.1.3).

    We have opened a SR in My Oracle Support but we are still stuck. Here is the the SR number(3-11827245841) if you want to have a look.



  • Rekha Ayothi Friday, February 5, 2016

    Hi Simon,

    I am sorry to hear that you are facing this issue. I will follow up with Oracle Support for the SR. Meanwhile, the fix for this issue is part of consolidated patch 21974404:R12.OWF.B.

    Please ensure that you have applied all the patches mentioned in My Oracle Support Note 1998019.1, in the specified sequence.



  • guest Monday, February 15, 2016

    We are getting this when we trying to access the rest services from moblie app

    oracle.apps.fnd.isg.app.ebs.impl.JCAServiceHandler.processPOSTRequest : Exception occured : DBWriteInteractionSpec Execute Failed Exception.

    rollback failed. Descriptor name: [unknown].

    Caused by java.sql.SQLRecoverableException: No more data to read from socket.

    Please see the logs for the full DBAdapter logging output prior to this exception. This exception is considered retriable, likely due to a communication failure. To classify it as non-retriable instead add property nonRetriableErrorCodes with value "17410" to your deployment descriptor (i.e. weblogic-ra.xml). To auto retry a retriable fault set these composite.xml properties for this invoke: jca.retry.interval, jca.retry.count, and jca.retry.backoff. All properties are integers.

    When we restart the oafm managed server it is working for some time and giving the same error.We rasied an SR with oracle but no solution provided till now.

    We are R12.2.5 with database.

  • Rekha Ayothi Tuesday, February 16, 2016

    Dear Guest,

    Can you mail me the SR number? Let me follow up with Oracle Support.



  • guest Tuesday, February 16, 2016

    Sr number is 3-11879225961

  • guest Tuesday, February 23, 2016

    We are still getting "ISG_SERVICE_EXECUTION_ERROR" after applying 21974404 on 12.1.3 and not able to find log file to see the errors.

  • Steven Chan Tuesday, February 23, 2016

    Hello, Guest,

    I'm sorry to hear that you've encountered an issue with this.

    We can provide general conceptual guidance here, but I'm afraid that this blog isn't the best place to get technical support for specific issues like the one that you're working through.

    Your best bet would be to log a formal Service Request via My Oracle Support (formerly Metalink) to get one of our specialists engaged.



  • srimathi badri Saturday, January 27, 2018
    Hi Rekha

    We have started using ISG in EBS12.1.3 to deploy REST based services to integrate EBS to other systems.
    IN 12.1.3 the SOA monitor is applicable only for SOP based services.
    1.Is there going to be any enhancement to have SOA monitor applicable to track and log REST based services.
    2. When we deploy a package there is no option to choose a specifc method of the package , but we have to deploy the entire package. But in Grants tab the option to choose a specific package is avaiable. Is there some patch that we are missing or is that option to deploy only speicif methods in a package not avaiable in 12.1.3?

  • Rekha Ayothi Thursday, February 1, 2018
    Hi Srimathi,

    Thanks for your message.
    1. As of today, SOA Monitor can be used to monitor and log SOAP messages. Please file an enhancement request in My Oracle Support for the requirement to track and log REST services in EBS.

    2. In EBS R12.1.3, when you deploy PL/SQL API as REST service, all public (and registered) methods are deployed. There is no option to individually select a method to deploy. Having said that, this feature is available in EBS R12.2.

  • Jarell Mallari Wednesday, July 11, 2018
    Hi Rekha, Steven,

    We're currently transitioning from Jersey REST services to SOA Gateway.

    These services will be consumed by other systems and front-ends (mobile/browser).

    How does one configure E-Business Suite to support the need for CORS in today's practice of mashing up data from different domains in the client side?

    We have 2 concerns here:

    1. Currently E-Business Suite does not provide a valid HTTP Response when a CORS preflight (OPTIONS) is requested.

    The exact response, with code 405 is:
    Request METHOD not supported

    I am assuming this is caused by a server configuration. In what layer oc4j or Apache I'm not sure, I don't have the config on hand so all I can do is speculate.

    What would be the best way to allow OPTIONS method?

    2. We'd like to add CORS response headers. If there is a configurable way, instead of manually coding it in our apps.

    Hope you could provide us the best approach to accomplish what we want.

    EBS platform version is 12.1.3.

  • Usher Wednesday, November 7, 2018
    Do you have any sample with .Net client invocation of Rest API
  • When we can get LOGS for Rest Service Sunday, October 13, 2019
    I understand there is development bug is raised on this.
    This is very much required, When we can expect this functionality ?
    If it is can not be delivered then allow us to customize $INST_TOP/ora/10.1.3/j2ee/oafm/application-deployments/oafm/webservices/orion-web.xml

    ISG REST Service Provider Application





    can we put our custom class by extending Oracle seeded one, then I believe our goal will be achieved.

    Apurba K Saha
  • Rekha Ayothi Monday, October 14, 2019
    Hi Apurba,

    Thanks for highlighting this requirement.

    I am afraid, this is not recommended approach to customize the setup. I suggest to stay tuned on this.

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