Quick Start

Set up your environment, generate an OAuth token for accessing resources, and retrieve an application to work on for Oracle Visual Builder using the REST API by performing the following tasks.

Step 1: Get Account Information

Get the account credentials for using Oracle Visual Builder from your account administrator. Specifically, you'll need:

User name and password for your Oracle Visual Builder account.
The URL of your Oracle Visual Builder instance, which is listed in the welcome e-mail you receive with your trial or purchased subscription.

Step 2: Install and Set Up cURL

The examples in this document use the cURL command-line tool to demonstrate how to access the Oracle Visual Builder REST API.

To connect securely to the server, you must install a version of cURL that supports SSL and provides an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. For more information about:

Using cURL, see cURL Access.
Authentication, see Authenticate.

The following procedure demonstrates how to install cURL on a Windows 64-bit system.

In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.
On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.
Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the ca-bundle.crt SSL CA certificate bundle in the folder where you installed cURL.
Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate bundle. For example:
```
C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt
```

You are now ready to send requests to the Oracle Visual Builder REST API using cURL.

Step 3: Use cURL to Run Your First Task (Get a query-filtered list of applications)

Use a cURL command, like the one below, to get a list of applications filtered by query parameters. Change myinstance.com to your service instance URL, as described in Send Requests.

curl -H 'Authorization: Bearer {token}' -X GET 'https://myinstance.com/ic/builder/resources/application/applist?appName=&orderBy=time&orderDir=desc&myApps=t&appsIAdmin=f&latestVersions=f&abcsProjectType=f&vbcsProjectType=t&maxProjectType=f&template=f&development=f&stage=f&live=f&liveLocked=f&obsolete=f&autoDeleted=f&softDeleted=f&offset=0&count=10'

where, {token} is replaced with the OAuth token you must have already generated and retrieved. The token enables you to access this resource without directly using your account credentials (username, password).