Oracle Analytics REST API Connector

The Oracle Analytics REST API Connector is now available in the September 2022 Oracle Analytics update in preview mode.

The connector now allows access to data directly from REST API endpoints.

​To access the REST API Connector, you will need to enable the feature in the Console System Settings preview section by switching on the toggle.

You will need to log off and back on again to apply the change to your instance. You should now see the REST API connector in the create > connections menu on the Oracle Analytics homepage.

In the next screen, you enter details of your REST API that you want to access. The basic information required for connecting are:
​

1. Base URL of the REST API
2. REST API endpoints
3. Authentication type
4. Authentication credentials

​
You can either enter the information in here directly or you can use a JSON template to enter all of the REST API information. A sample JSON template file can be found at the bottom of this post.

If you decide to enter information of the REST API for your connector using a JSON file, you will need the contents to match the syntax below. If your API has several endpoints that you will be using then enter each endpoint URL in the endpoints section.

​Ensure that the correct authentication type is entered. Once all completed, the connection can be used as a standard connection to create a dataset. .

During the testing of this new functionality, the REST API used BasicAuth authentication and the API key was supposed to be entered in the username field. The issue here is that the password is a mandatory field and can't be left blank. The way round this was to re-enter the API key in the password field as well.

Once the connection has been created, you can create a dataset using the REST API connection in the normal fashion.

In the connection panel of the New Dataset window expand the REST API connection to the AUTOREST schema to access the result sets of the endpoints. The RESULTS tables contain the data from the endpoints and the others contain metadata of the endpoints.

The new REST API connector is a great addition to the Oracle Analytics capability. It now gives users another means of bringing additional data in to uncover even more insights from your enterprise data assets.

rest-api-connector-template.json
File Size:	0 kb
File Type:	json

Download File

---

This website uses marketing and tracking technologies. Opting out of this will opt you out of all cookies, except for those needed to run the website. Note that some products may not work as well without tracking cookies.

Opt Out of Cookies