Oracle Cloud offers a broad portfolio of software as a service applications, platform as a service, and social capabilities, all on a subscription basis. Oracle Cloud delivers instant value and productivity for end users, administrators, and developers alike through functionally rich, integrated, secure, enterprise cloud services.
 Get a Free Magzine ...Profit:The Executive's Guide to Oracle Applications

Subscribe to the OracleAppsHub to receive notifications when there are new posts:

 get RSS feed
 Oracle Fusion Applications (OFA) is a portfolio of next generation suite of software applications from Oracle Corporation. It is distributed across various product families; including financial management, human capital management, customer relationship management, supply chain management, procurement, governance, and project portfolio management
 Get a Free Magzine ...Profit:The Executive's Guide to Oracle Applications

The world of Oracle API

Posted on February 12th, 2008 by Sanjit Anand |Print This Post Print This Post |Email This Post Email This Post

Have you tried OracleappsHub in ipad/iphone/smart Phone? Don't wait. try it today

There are 3 types of APIs exist in EBS.

double-arrowPrivate APIs : Private API's are one which Oracle normally using internal, development purpose only. Details are not provided to anyone outside of the immediate development environment, nor are they intended for use by anyone outside of the e-Business Suite development environment.

double-arrowPublic APIs : These are designed for customers and Oracle consultants to integrate non-Oracle systems into Oracle e-Business Suite or to extend the functionality of the base products. Oracle does not support public APIs unless they are published in a reference manual.

double-arrowPublic, published APIs : These are one which Oracle guaranteed to remain valid from release to release, and patches will not alter the API behaviour. Public, published APIs are supported by Oracle to the same extent as released software.

Is there any way find out whether a standard API is PUBLIC or not in Oracle Application?

Yes, there is way, what you have do ,once you are able to find the information for API from irep, the next you have to find the file name and then you need to pull all information from specification header to know which one is public.

Take a simple case, you need to find API FND_USER_PKG which is defined in file AFSCUSRB.pls

logon to Unix box, and release this sort of command

grep -i public $FND_TOP/patch/115/sql/AFSCUSRB.pls

api's world

Based on the above result one can determine whether API is PUBLIC or not.

Simple example for checking AR Public APIs for finding the status

grep -i public $AR_TOP/patch/115/sql/ARXPRELB.pls
grep -i public $AR_TOP/patch/115/sql/ARXPRELS.pls
grep -i public $AR_TOP/patch/115/sql/ARXPRECS.pls
grep -i public $AR_TOP/patch/115/sql/ARXPRECB.pls

Important to Note:

For non-published APIs, Oracle expressly does not provide any guarantees regarding consistency of naming, usage, or behaviour of any API (public or private) between releases.

It Might be possible that a patch could alter any characteristic of any non-published e-Business Suite API.

Where are APIs located ?

For Oracle release 10.7, the APIs are located in the operating system directories such as:

$APPL_TOP/patchsc/107/sql

For Oracle release 11 and release 11i, the APIs are located in the operating system directories:

$APPL_TOP/patch/xxx/sql

where xxx represents the release 110 or 115.

Is there any tracking mechanism for API versions in different Applications releases?

As confirmed by some time back by Oracle support team , there is no such database object in Oracle Applications that keep such kind of information.

All APIs are owned and managed by different product groups within Oracle.

Normally each release comes with either product update notes, or and "About" note. You would need to review these documents for each E-Business Product.

The most comprehensive are the family pack "About" notes, as they in turn reference each individual product "About" note, which lists things like "Changes".

Related Posts

Posted in API Integration, EBS Suite | 14 Comments »Email This Post Email This Post | Print This Post Print This Post

Have you tried OracleappsHub in ipad/iphone/smart Phone? Don't wait. try it today
14 Responses
  1. Nigel Thomas Says:

    Sanjit – there’s a little error in the first bullet:

    “Private APIs : Public API’s are…”

    Substitute Private instead of Public.

    Good work!

    Regards Nigel

  2. sanjit Says:

    Thanks Nigel for nice word.

  3. API’s or Open Interface Says:

    […] or Open InterfaceThe world of Oracle APIPO: Tips and useful QuerySubscribeHappy Lunar new yearHighlights:Release 12 Oracle EBS FinancialsR12 […]

  4. Ramesh Says:

    What is the difference b/w Oracle API and Oracle standard Package?

    Regards Ramesh

  5. Approved Supplier Lists (ASL) Says:

    […] Usage Note :**Don’t use private API’s , unless Oracle is documented, these are mostly used by Oracle development purpose, unless untill […]

  6. AR Invoice API (Application Program Interface ) Says:

    […] The world of Oracle API […]

  7. AR Deposit : Details, setup, Flow, Accounting and API Says:

    […] The world of Oracle API […]

  8. AR Adjustments : Details,setup, Flow, Accounting and API (Part -II) Says:

    […] The world of Oracle API […]

  9. AR Adjustments : API - Sample code Says:

    […] The world of Oracle API […]

  10. A Newbie’s Guide to E-Business Suite Integration (by Custom Code using API’S!”) Says:

    […] First thing you have to do is, you need to initialize Applications Information such as user_id,responsiblity_id and application_id if you are in R11i. For R12,there is slightly change in APPS initialization. […]

  11. Bespoke Application & Utilizing HR/Payroll APIs | OracleApps Epicenter Says:

    […] The world of Oracle API […]

  12. Ravi Says:

    Hi all,
    Is there any guidelines for standard APIs ?
    The disadvantage in using API i feel is that it is very hard to debug if some thing goes wrong.

    Regards,
    Ravi.

  13. TCA : Party Purge API | OracleApps Epicenter Says:

    […] This API is not published by Oraclc for public use. You can check thIS post before using Oracle API's. […]

  14. Srikanth Says:

    Can you please give me the list of Public APIs for iExpense module.

Leave a Comment

Please note: Comment moderation is enabled and may delay your comment. There is no need to resubmit your comment.