1. REST API for Oracle Clinical One PlatformREST API for Clinical One Platform
  2. Change History

Change History

Review what's new in this document

July 2024

Change Type Description
  • Designer EDC
  • Query
  • Reporting
  • Users, Permissions and Roles
 New API endpoints For details on the specific new enpoints see 24.1.1 Rest API patch updates.
  • Reporting
 Updated endpoints Updates had been included to support new Subject Randomization Data Extract report.

May 2024

Change Type Description
Integrate data into Clinical One via Digital Gateway New use case

A new use case to integrate data into Clinical One via Digital Gateway using Rest APIs has been added to the corresponding section.

As part of this change, all related topics and other uses cases have been reformatted, and all links have been updated to point to the newest APIs versions.
  • Data Hub
  • Data Integration
  • Data Capture
  • Designer
  • Designer EDC
  • Randomization and Supplies
  • Query
  • Rules
  • Sites and Depots
 New API endpoints For details on the specific new enpoints see 24.1 Rest API updates.
  • Query
  • Rule Designer
 Deprecated endpoints For details on the specific deprecated enpoints see 24.1 Rest API updates.
  • Data Capture
  • Designer
  • Randomization and Supplies
 Deleted endpoints For details on the specific deleted enpoints see 24.1 Rest API updates.

December 2023

Change Type Description
About API tasks and corresponding permissions New permission The ec-designer-edc-svc permission has been added to access some APIs of the Designer category.
  • Data Action
  • Data Hub
  • Data Integration
  • Data Capture
  • Designer
  • Library
  • Randomization and Supplies
  • Query
  • Rule Designer
  • Sites and Depots
 New API endpoints For details on the specific new enpoints see 23.3 Rest API updates.
  • Data Action
  • Data Capture
  • Notifications
  • Query
  • Sites and Depots
 Deprecated endpoints For details on the specific deprecated enpoints see 23.3 Rest API updates.
  • Codelist
  • File Upload
 Deleted endpoints For details on the specific deleted enpoints see 23.3 Rest API updates.

September 2023

Change Type Description
ODM Extract for clinical data New and revised content

The cURL examples have been updated to the latest API versions respectively.

The table has been updated with new or modified clinical data response elements from ODM extracts.
ODM Extract for metadata New and revised content The table has been updated with new or modified metadata response elements from ODM extracts.
Comments New service Comments service has been added as a new API category under the Tasks section of this guide. Details abaut its corresponding permission were added in About API tasks and corresponding permissions.
  • Codelist
  • Data Action
  • Data Hub
  • Data Capture
  • Designer
  • Library
  • Query
  • Randomization and Supplies
  • Reporting
  • Sites and Depots
  • Users, Permissions and Roles
 New API endpoints For details on the specific new enpoints see 23.2 Rest API Updates.
  • Data Capture
  • Designer
  • Library
  • Reporting
 Deprecated endpoints For details on the specific deprecated enpoints see 23.2 Rest API Updates.

May 2023

Cahnage Type Description
  • Data Hub
  • Library
 New API endpoints For details on the specific new enpoints see 23.1 Rest API updates.

April 2023

The following table lists changes introduced in this version of the document:

Change Type Description
ODM Extract for clinical data New and revised content

The cURL examples have been updated to the latest API versions respectively.

The table has been updated with new or modified clinical data response elements from ODM extracts.
ODM Extract for metadata New and revised content The table has been updated with new or modified metadata response elements from ODM extracts.
Library New service Library service has been added as a new API category under the Tasks section of this guide. Details abaut its corresponding permission were added in About API tasks and corresponding permissions.
  • Data Actions
  • Data Capture
  • Data Hub
  • Designer
  • Notifications
  • Randomization and Supplies
  • Users, Permissions and Roles
 New API endpoints For details on the specific new enpoints see 23.1 Rest API updates.
  • Data Capture
  • Query
  • Rules
  • Rules Designer
 Deprecated endpoints For details on the specific deprecated enpoints see 23.1 Rest API updates.

March 2023

The following table lists changes introduced in this version of the document:

Change Type Description
  • Codelist
  • Data Actions
  • Data Capture
  • Data Hub
  • Data Integration
  • Designer
  • Randomization and Supplies
  • Rules
  • Sites and Depots
  • Users, Permissions and Roles
 New API endpoints For details on the specific new enpoints see 22.4 Rest API updates.
  • Designer
  • Users, Permissions and Roles
 Deprecated endpoints For details on the specific deprecated enpoints see 22.4 Rest API updates.

November 2022

The following table lists changes introduced in this version of the document:

Change Type Description
About API tasks and corresponding permissions New services included Data Capture category has been split into three categories, each with its associated permission: Data Capture, Data Integration and Data Action.
Create a user account in Added details for integration users Guidelines to include external data source in username for integration users for EU regulation compliance.

To see newly added and deprecated endpoints by service, see RestAPI updates in the Oracle Life Sciences Clinical One Platform Release Notes.

June 2022

The following table lists changes introduced in this version of the document:

Change Type Description
Clinical data New and revised content The table has been updated with new or modified clinical data response elements from ODM extracts.
Meta data New and revised content The table has been updated with new or modified meta data response elements from ODM extracts.
Admin data Revised content The table has been updated with modified admin data response elements from ODM extracts.

April 2022

The following table lists changes introduced in this version of the document:

Change Type Description
Clinical data New and revised content The table has been updated with new or modified clinical data response elements from ODM extracts.
Meta data New and revised content The table has been updated with new or modified meta data response elements from ODM extracts.

January 2022

The following table lists changes introduced in this version of the document:

Change Type Description
Deprecation and versioning New content Explains the deprecation of APIs and recommends users to always use the newest version of all APIs.
Get started as an API developer Revised content Updated the content to include the correct information about the amount of time an authentication token is valid for.

October 2021

The following table lists changes introduced in this version of the document:

Change Type Description
Design a study use case Revised content Updated the content to include correct information for this use case.
Add randomization to a study use case New use case Introduced a new use case that explains how to add randomization to a study using Oracle Clinical One Platform REST API.
Removed Provision a user for ODM-XML data extracts and added a new use case Perform ODM-XML data extracts New use case Removed a prior use case and introduced a new use case that explains how to perform ODM-XML data extracts using Oracle Clinical One Platform REST API.
Retrieve study information use case New use case Introduced a new use case that explains how to retrieve study information using Oracle Clinical One Platform REST API.

August 2021

The following table lists changes introduced in this version of the document:

Change Type Description
Provision a user for ODM-XML Data Extracts New content Updated the Get Started content with the relevant instructions and user assistance content on how to provision a user for ODM-XML data extracts.
Save data in a form use case New use case Introduced a new use case that provides working examples on how to create a new site, add new subjects to your study, and store form data in their visits using Oracle Clinical One Platform REST API.
Get started as system administrator Revised content About API tasks and corresponding permissions was added under Generate a client ID and secret.
Get started as an API developer Revised content Updated the content with relevant instructions and user assistance content for API developers.

April 2021

The following table lists changes introduced in this version of the document:

Change Type Description
Download a Standard Report use case New use case Introduced a new use case that provides working examples to build and download standard reports using Oracle Clinical One Platform REST API.

February 2021

The following table lists changes introduced in this version of the document:

Change Type Description
Design a Study use case New use case for designing a study Introduced a new use case that provides working examples to design a study using Oracle Clinical One Platform REST API.
  • Users, Permissions, and Roles
  • Code list
  • Coding
  • Data Collection
  • Designer
  • File Upload
  • Notifications
  • Randomization and Supplies
  • Reporting
  • Sites and Depots
 New API endpoints Introduced new API endpoints for all of the mentioned services.
Get started as a system administrator Transcription error Corrected the product name for Oracle Health IAMS.
Get started as an API developer Transcription error Corrected the sample code in Step 4, 2 to include a line of code for the client ID and service.

June 2020

The following table lists changes introduced in this version of the document:

Change Type Description
Code list New API endpoints Introduced new API endpoints for the Code list service.
Designer New API endpoints Introduced new API endpoints for the Designer service.
Rules New API endpoints Introduced new API endpoints for the Rules service.
Users, Permissions, and Roles New API endpoints Introduced new API endpoints for the Users, Permissions and Roles service.
Get Started New content Updated the Get Started content with relevant instructions and user assistance content for API developers.