cURL Access

The examples within this document use cURL to demonstrate how to access the Oracle Process Cloud Service REST API.

To use cURL to access the Oracle Process Cloud Service REST API:

  • Install cURL, as described in Quick Start.

  • In a command window, set the cURL environment variable, CURL_CA_BUNDLE, to the location of your local CA certificate bundle. For information about CA certificate verification using cURL, see: http://curl.haxx.se/docs/sslcerts.html.

  • Invoke cURL and specify one or more of the command-line options defined in the following table, as required, to direct its execution.

    This table summarizes the cURL options used in the command examples.

    cURL Option

    Description

    -d, --data '{"name":"value"}' -d, --data @file.json Identifies the request document, in JSON format, on the local machine.
    -F, --form @file.json Identifies form data, in JSON format, on the local machine.
    -H, --header Defines the content type of the request data.
    -i Displays response header information.
    -o path Identifies the response output on the local machine. Use this option for export operations and to save a response to a file.
    -u, --user username:password Specifies the user name and password for the Oracle Process Cloud Service account.
    -X, --request Indicates the type of request (for example, GET, POST, and so on).
The following example cURL command posts a comment to the task with the ID 123456:
curl -u jstein:welcome1
 -H "Content-Type:application/json"
 -H "Accept: application/json"
 -X POST
 -d '{"commentStr":"add test Comment"}'
 https://example.com/bpm/api/3.0/tasks/123456/comments

where, <version> - REST API version. For example, 3.0.

The latest Oracle Process Cloud Service REST API version is 3.0. See Send Requests.