Frequently Asked Questions (FAQs)

Why have parts of the Tasks section changed?

To ensure you can easily access all the information that you need, we are working on restructuring the REST API guide. As a result, some of the categories listed under the Tasks section of this guide now follow a slightly different hierarchy, to which all categories will eventually conform. For example:

From:
  • Tasks > Data Capture > Data Elements > v4.0 > Clear data elements scope by study ID and mode
To:
  • Tasks > Data Capture > Data Elements > Clear data elements scope by study ID and mode>V4.0

This documentation update will be completed in future releases.

What are the differences between using client credentials and a password grant to generate a client ID and secret?

Use Password Grant when an end-user Oracle Life Sciences IAMS account will be used to make the API calls. Use Client Credentials for automated system-to-system API calls, where an actual end-user isn't necessarily involved long term. With client credentials, the password is not actually used to authenticate the API call.

For step-by-step instructions on how to generate a client ID and secret, see Generate a client ID and secret. For details about authentication on each type of client, see Get a token for authentication.

What options can I use to invoke cURL?

This table summarizes the cURL options used in the command examples. For example, here's how a code line would look like in cURL:

curl -i -X GET -u <username>:<password> -H <request-header>:<value> https://<subdomain>.<domain>.com/<path>/<resource-path>
cURL Option Description
-d, --data @file.json Identifies the file that contains the request body, in JSON format, on the local machine. Alternatively, you can pass the request body with -d"{id=5,status='OK'}.
-F, --form @file.json Identifies form data, in JSON format, on the local machine.
-H --header, -I -include, and -X --request <method>

Defines one or both of the following:

  • Content type of the request document
-i Displays response header information.
-X Indicates the type of request (for example, GET, POST).

What are some examples of API requests for Oracle Clinical One Platform?

After you set up your REST client, you can send a request to ensure that your connection works. For example, suppose you want to create multiple data elements for a subject. You can use the following request:
{   "type":"object",
"properties":{ "context":{ "$ref":"#/components/schemas/Context" }, "dataElements":{ "type":"array", "items":{ "$ref":"#/components/schemas/CoreDataElement" } } } }
If the request is successful, then you should receive a 200 response with a body such as the following: 
{    
"type":"array",
"items":{
    "$ref":"#/components/schemas/DataElementDto20"
}
}

Do I have to request a token every time I need to make an API call?

No, you don't have to request a new token every time you make an API call. However, do keep in mind that a token is valid for 10 minutes. If you plan on making numerous API calls throughout the day, you'll have to generate a new token every 10 minutes.

How do I construct my URL for sending requests?

Use the following guidelines when sending requests using the Oracle Clinical One Platform REST API.

Property Description
URL Structure
Access the Clinical One REST resources using the following URL structure:
https://<subdomain>.<domain>.com/<resource-path>
Where:
  • <subdomain>.<domain>.com is the host where the Oracle Clinical One Platform APIs are running.
  • <resource-path> is the relative path that defines the resource. For a complete list of resources and the paths for each, see All REST Endpoints.
Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on Oracle Clinical One Platform APIs using the standard HTTP method requests GET, PUT, POST, and DELETE.
Media Types

The APIs currently support only the application/JSON media type.
Supported Headers

Oracle Clinical One Platform REST APIs support only the Content-Type header to be passed in the header section of the HTTP request or response. The value for this header is specific to each API endpoint.
Compression

Use of compression on the Oracle Clinical One Platform REST APIs resource request and response is not supported at this time.