Using data from REST POST API with OJ Table

DaveArch · Jun 16, 2022 8:51AM

JET Version: 10.0

Hi JET Community

We have a requirement to fetch data from a REST API that requires information sent to it as a HTTP POST and serve it up in an OJ Table (appreciating that the API does not conform to REST principles in that it should really be a GET). This is due to the complexity of the payload required to filter the data from the service.

Typically with JET 10.x, we would use OJ Collection and OJ Model with OJ Table to give us light-weight data fetching along all the nice paging for free. Given that this is a POST, we cannot do that (unless anyone has a bright ideas on this).

Therefore, we would typically look to use ArrayDataProvider or MutableArrayDataProvider to help us here where we would pre-load the data provider in one hit. Unfortunately, we could be dealing with fairly large data sets and therefore don’t want to be fetching all the data over the network in one go. The API does support fetch size and offset in the POST payload so we need to work out how to leverage that with the table itself.

We were thinking therefore that we could listen for an event which indicated that the user had scrolled down past the watermark which triggers the data provider to do a fetch and then perform the POST request with the relevant offset and fetch size. We would then load that into the underlying array backing the data provider.

We have been looking through the API’s and the Cookbook but can’t see a pattern for this.

Does anyone have any ideas?

Many thanks

John 'JB' Brock-Oracle · Jun 16, 2022 3:01PM

Hi Dave, you can still use the Common Model API with a POST method. Just us a customURL and set the method to POST instead of the default of GET. Take a look at this Cookbook demo paghttps://www.oracle.com/webfolder/technetwork/jet/jetCookbook.html?component=custom&demo=customURL

John 'JB' Brock-Oracle · Jun 16, 2022 3:01PM

Hi Dave, you can still use the Common Model API with a POST method. Just us a customURL and set the method to POST instead of the default of GET. Take a look at this Cookbook demo paghttps://www.oracle.com/webfolder/technetwork/jet/jetCookbook.html?component=custom&demo=customURL

DaveArch · Jun 16, 2022 5:44PM

Hi John.

Thanks for your reply.

This is exactly what we need and it works perfectly.

Will the same outcome be able to be achieved with RESTDataProvider should we upgrade and use that in place of CollectionDataProvider in the future?

For reference to the wider community, if you were using the above approach with a POST, you would pass the payload in the 'data' attribute.

this.getURL = (operation, collection, options) => {

   let data = {
    "whatever is required": "for the API",
   };

   const retObj = {};
   retObj["type"] = "POST";
   retObj["url"] = "https://..";
   retObj["data"] = JSON.stringify(data);    
   // + Other properties passed by Collection to the AJAX call as required   

   return retObj;
};

John 'JB' Brock-Oracle · Jun 16, 2022 5:52PM

The RESTDataProvider can be edited to use a method POST instead of GET as well if you like. The fetchFirst method of the RESTDataProvider creates a new Request object, which is a standard HTTP request object that you can set the properties of.

This Learning Path was updated with the JET v12 release to use RESTDataProvider in a CRUD use case. It may be valuable to review. https://docs.oracle.com/en/middleware/developer-tools/jet/12.1/webapplications.html

DaveArch · Jun 16, 2022 6:23PM

Really helpful - thanks John.

This is a real ‘get out of jail’ card for us!

Forum Stats

Quick Links

Categories

Using data from REST POST API with OJ Table

Best Answer

Answers

Data

Databases

Development

Development Tools

Open Source

Programs

Forum Stats

Categories

Using data from REST POST API with OJ Table

Best Answer

Answers