Overview
Starting from Oracle E-Business Suite Mobile Foundation Release 6.1,
Oracle provides APIs corresponding to portions of the Oracle E-Business
Suite mobile apps’ functionality. These APIs are available in the Oracle
Integration Repository where you can search, view, and deploy them as
REST services. You can also develop and publish additional custom APIs to Oracle Integration Repository that can be deployed as REST services.
The standard REST services along with additional custom REST services can be used to develop custom mobile apps on Oracle E-Business Suite either using E-Business Suite Mobile Foundation Login Component or using a mobile application development framework of your choice.
Refer to REST
API Patches for Custom App Development in Oracle E-Business Suite Mobile
Foundation Release 6.1in Oracle E-Business Suite Mobile Apps Administrator’s Guide, Release 12.1 and 12.2 for the list of patches to apply to get the EBS Mobile Release APIs.
Using EBS Mobile APIs
In order to search and manage EBS Mobile APIs easily, they are categorized under a common Business Entity called Mobile Optimized API. You can access the EBS Mobile APIs using below steps.
Search
Log in to the Oracle Integration Repository through the Integrated SOA Gateway responsibility and click Search. In the Search page, use business entity as Mobile Optimized API to search for all EBS mobile apps’ APIs.
In addition to using business entity value as Mobile Optimized API, you can use additional search values to limit the search results. For example, to retrieve the APIs for the
Approvals app, you can enter Applications Technology as the product
family and search.
Browse
You can also access required mobile APIs by browsing the list of interfaces
using the navigation tree on the left pane. Select Product Family in the View By field
and then expand the tree nodes to locate your desired product family, then product, and then business entity.
For example, expand the Applications Technology product family node, and then Workflow and select the Mobile Optimized API business entity.
Deploy
Once required mobile APIs are located in Oracle Integration Repository, you can create grants to allow only authorized users to access these APIs and deploy them as REST services. Once the APIs are deployed as REST services you can use View WADL link to review the REST API definition using the WADL (Web Application Definition Language) file that provides details of the REST resources, input and output data types.
For more information about deploying REST services, refer to Chapter 3 Administering Native Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Mobile Approvals APIs
Oracle Workflow publishes a number of APIs that are used by Mobile Approvals app. Mobile Approvals APIs are grouped into two different interfaces.
- Approvals Management
- Approvals Details and Actions
Approvals Management
Provides methods to retrieve Oracle Workflow
approval types, get pending approvals for a given type, and get open notifications.
- Get Open Notifications – Gets a list of all open notifications for the current approver, including both
response-required and FYI notifications. To retrieve the list in batches, specify
the page size and page number of the batch to retrieve for the current request - Get Approval Types – Gets a list of the approval types for which the current approver has at least one
pending approval. For example, Expense Reports, Purchase Requisitions, Purchase Orders are example of approval types. - Get Pending Approvals by Type – Gets a list of pending approvals for the current approver for a given approval type.
Approvals Details and Actions
Provides methods to retrieve Oracle Workflow
approval details, retrieve approval participants, and perform actions such as requesting
information, providing information, and respond to the approval.
- Get Approval Header – Gets header attributes for a given approval notification.
- Get Approval Details – Gets additional approval details for a given approval notification and the content
for a specific detail region for that notification. - Get Approval Participants – Gets a list of users who participated in the approval process for the current
approval notification to request more information from. - Request Information – Submits a request for more information from a specified approval participant for a
given approval notification. - Provide Information – Submits information provided by another participant as a reply to the approver who
requested the information. - Reassign Approval – Reassigns the approval notification to another user.
- Submit Approval – Submits the Approve or Reject decision for an approval notification, with an
optional comment.