Get a list of reports ready to be downloaded

Make a GET request to see a list of all reports ready to be downloaded.

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 the generated reports available for download

Given a rptId, run the following cURL call to get all reports that are ready to be downloaded.

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-reporting-svc/rest/v2.0/reportmetadata/downloadList?studyId={studyId}&mode={mode}&rptId={rptId}&limit=1&offset=0

Take note of the downloadId value from the response object. In order to download the specific report you just generated using Rest APIs you will need this data. The download ID is the same as the job ID generated while creating the report. See the following section of a sample response:


{
  "status" : "success",
  "result" : {
    "hasMore" : "false",
    "totalResults" : 1,
    "count" : 1,
    "limit" : 1,
    "offset" : 0,
    "reportId" : "E341BB429E7D44E3989D113A504F3BF8",
    "reportRunStatus" : [ {
      "rptKickoffDatetime" : "2021-03-25T07:04:16.062Z",
      "rptFormat" : "XPORT",
      "currSearchSpec" : "{\"fieldSpecsList\":[{\"fieldName\":\"File Name\",\"fieldSequence\":0,\"fieldValueList\":[\"ls_SubjectDataExtract_20210325\"],\"fieldType\":\"list\"}]}",
      "currSortSpec" : null,
      "downloadId" : "C7915941393842F9A7983B8B654F3C7D",
      "rptId" : "E341BB429E7D44E3989D113A504F3BF8"
    } ]

For more information on getting all reports available for download, see Get the generated reports available for download.

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.