cURL Access

The examples within this document use cURL to demonstrate how to access the REST API for Self-Management.

To use cURL to access the REST API for Self-Management:

  1. Install cURL, as described in Quick Start.

  2. When running cURL from a Windows command shell only, set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. Alternatively, you can specify the location of your local CA certificate bundle on the command line, using the --cacert command-line option.

    You can download an SSL CA certificate bundle from http://curl.haxx.se/docs/caextract.html or provide your own. For information about CA certificate verification using cURL, see http://curl.haxx.se/docs/sslcerts.html.

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

    cURL Option Description
    -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 Defines one or both of the following:
    • Content type of the request document

    • Custom header, X-ID-TENANT-NAME, to identify the identity domain

    -i Displays response header information.
    -u, --user username:password Specifies the user name and password for the Oracle Content Management account.
    -X Indicates the type of request (GET, POST, PUT, or DELETE).

For example:

curl -i -X GET -u username:password -H request-header:value https://subdomain.domain.com/path/resource-path

Where:

  • username:password - User name and password for Oracle Content Management.

  • request-header:value - Request header.

  • subdomain.domain.com[:port] - Host and port where Oracle Content Management is running.

  • version - Version of the REST API; for example: 1.2.

  • resource-path - Relative path that defines the resource.