Send Requests

Use the following guidelines when sending requests using the Oracle Visual Builder REST API.

To call Oracle Visual Builder REST resources, you need to create the required URL using the Service console URL. To obtain this URL, sign in to your Oracle Cloud Infrastructure console and navigate to the required Oracle Visual Builder instance. On the Visual Builder instance details page, click the Copy link beside the Service console URL field to copy this URL.

Create the URL Using the Service Instance URL

To call Oracle Visual Builder REST resources using the service instance URL, use the following structure:

https://service-instance-url/ic/builder/resource-path

where:

• service-instance-url is the address where the Oracle Visual Builder instance is running.

• /ic/builder/ is the prefix for the path to the resource.
• resource-path is the relative path that defines one of these resources:

  • For Application resources: /resources/application/
  • For Authentication resources: /public/
  • For Data Management resources: /design/{appid}/{appver}/resources/datamgr/

Note:

The relative path to each endpoint always includes the /ic/builder/ prefix. For example, the full relative path (prefix + relative path) for the Authentication endpoint is /ic/builder/public/token.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on Oracle Visual Builder resources using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
GET	Retrieve information about a resource. In the Oracle Visual Builder REST API, this method is used to retrieve a filtered list of applications and export data records from one of the application's entities to a CSV file.
POST	Create a resource. In the Oracle Visual Builder REST API, this method is used to import data records from a file into an application entity, generate an OAuth token using username and password and return it using the endpoint's payload, lock a live application, or unlock a locked live application.
PUT	Update a resource.
DELETE	Delete a resource.

Note:

The HTTP PUT method is used to "upload" items to a particular URI, or overwrite what is already there, in that URI. The HTTP POST method, on the other hand, provides a way to submit data that is related to a given URI.

Supported Media Types

The media types supported by the Oracle Visual Builder REST API are:

• application/json

• application/x-www-form-urlencoded
• text/csv
• application/zip
• application/vnd.ms-excel
• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Supported Headers

Oracle Visual Builder REST API supports these headers that can be passed in the header section of the HTTP request or response:

Header	Description	Example
Content-Type	Media type of the body of the request. Required for POST and PUT requests.	Content-Type: application/json
Accept	Media type of the body of the response.	Accept: application/json