Get all available reports

Make a GET request to get all reports available to you and obtain the report ID for the report you wish to generate.

Note:

To run these Oracle Clinical One Platform API calls, you need to include an authentication token. For instructions on how to generate your authentication token, see Get a token for authentication and Use the token to make an API request.
For every API call make sure you construct the URL using the correct server URL and parameters values.

For the following API calls, you need the studyID and mode. These values are retrieved as part of a prerequisite, see Get study information.

Get metadata for all reports available

Run the following cURL call to get a list of all available reports and their details, based on query parameters:

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-reporting-svc/rest/v1.0/reportmetadata?studyId={studyId}&mode={mode}"

To make subsequent calls for a specific report, take note of the reportId value. In order to generate and download a specific report using Rest APIs you will need this data. See the following section of a sample response for the Subject Data Extract report:

{
  "status": "success",
  "result": [
    {
      "reportId": "E341BB429E7D44E3989D113A504F3BF8",
      "reportName": "Subject Data Extract",
      "reportType": "Study Production",
      "rptTypeSeq": 1,
      "rptSeq": 1
    }
  ]
}

For more information on this API, like its parameters and response objects, see Get metadata for all reports based on query parameters.

Tip:

There are many different Clinical One APIs that could help you complete a particular task. Browse for these and other related APIs under the Tasks section of this guide. If you see any deprecated endpoint, look for its newest version.