Пропустить навигацию
Brian Fry-Oracle

Accessing Business Objects via REST

Опубликовано: Brian Fry-Oracle 20.01.2017

When you define or edit a custom business object in ABCS, the system does two critical things. Firstly, a table is created (or updated) in the ABCS schema. This table persists the data that is managed by the business object. Secondly, ABCS generates a REST API for retrieving and manipulating data. The REST API includes operations for querying, inserting, updating and deleting data. Pages that you create in ABCS make use of this API for performing the requested actions, for example, an Edit form on a Contact object will automatically call the PATCH operation on the Contact REST API.


In some cases (primarily for integration with other systems), it may be desirable to invoke the REST API for a business object from outside ABCS. In this blog post, I'll show how you can call the REST API of a custom business object from an external client.


Define the Business Object in ABCS

  1. Create a new application.
    • Start by creating a new application. The id of the application will appear in the URL for the REST API. In this example, I name the application HR Application, and provide HRApp as the id.


  2. In the page designer, create a business object.
    • Create a business object using either approach of creating it from the page designer (drop a table onto a page), or from the Business Objects tab in the Data Designer. In this case, I've created a business object called Employee and added fields for firstname, lastname, hiredate, and salary.

      Here is how the object looks in the Data Designer:


  3. To simplify example, allow anonymous access to the application.
    • To simplify this example, I've used the Security Settings panel to enable anonymous access to my application and pages.

  4. Publish the app and add data.
    • Stage, then Publish the application. Now, run the published application and add some data. Note the URL for your application.



Access the REST API

  1. Identify REST URL and call from curl.
  1. API documentation
    • The REST API for the business objects contain descriptive metadata. To access the metadata of the object, you can request the /describe resource of the business object as shown below.



In a later blog post, we will cover aspects of invoking the REST API for a secure service.

As we've shown in a previous blog entry that Oracle Application Builder Cloud Service is able to add REST services that were created using Oracle ADF as a source of data.

In the video below you'll see how you can use this approach to get data from Oracle HCM and build an Oracle ABCS application with ease.

Oracle HCM publishes a set of REST interfaces - which are built on Oracle ADF - so integration is straight forward.


Once you add the service to ABCS, you can use it as a base for pages, including leveraging the built-in support for advanced query capabilities.

In the demo below we are building a simple application that let us track the cars of the various employees - something that can be used by the guards at our facility for example.

We use a REST service to get a list of the employees, and then create a custom ABCS business object that tracks the details of a car associated with a specific employees.


Check it out: