Using cURL

Set up your environment and create your first report for Oracle Prime using the API by performing the following steps.

Step 1: Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to manage reports using the APIs. Specifically, you will need:

  • Username and password for Oracle Prime
  • The URL of your Oracle Prime instance

Step 2: Install cURL

The examples within this topic use the cURL command-line tool to demonstrate how to access the Oracle Prime API.

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

To install cURL on a Windows 64-bit system:

  1. In your browser, navigate to the cURL home page and click Download in the left navigation menu.
  2. 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.
  3. 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.
  4. 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 Prime using cURL.

Step 3: Fetch Report Details

Run this cURL command to return an existing report definition:

curl --u username:password -H "Accept:application/json" -X GET 
      http://<hostName>:<portNumber>/primeapi/restapi/v<release level>/<service>

For example, to fetch a project object by its project ID:

curl --u jsmith:mypassword1 -H "Accept:application/json" -X GET
http://<server>:<port>/primeapi/restapi/v16.2/project/{id}