4 REST API updates

See the newly added, deprecated, and deleted endpoints in Oracle Clinical One Platform 26.0.1.

Note:

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.

Permissions

For this release, no new services or permissions have been added. Only existing services have been updated.

Service updates

The following services are updated:

Data Hub

Change Endpoint
New
  • GET /v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/metrics
  • GET /v1.0/tenant/{tenantId}/{mode}/dhSynchupTime
  • POST /v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v8.0/tenant/{tenantId}/studies/{studyId}/dataCollection
  • GET /v9.0/studies/{studyId}/{mode}/odm/metadata
Deprecated
  • POST /v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v6.0/tenant/{tenantId}/studies/{studyId}/dataCollection
  • GET /v7.0/studies/{studyId}/{mode}/odm/metadata

Data Integration

Change Endpoint
New
  • GET /v2.0/studies/{studyId}/{mode}/subjects
Deprecated
  • GET /v1.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
  • GET /v1.0/studies/{studyId}/{mode}/subjects/history/all
  • GET /v1.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
  • GET /v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
  • GET /v2.0/studies/{studyId}/{mode}/subjects/history/all
  • GET /v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
  • GET /v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Notifications

Change Endpoint
Deleted
  • DELETE /v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
  • GET /v1.0/studies/{studyId}/{mode}/{rightname}

Randomization and supplies

Change Endpoint
New
  • GET /v1.0/studies/{studyId}/{mode}/allShipments

Query management

Change Endpoint
Deleted
  • POST /v1.0/studies/{studyId}/{mode}/queries/subjectsitetransfer
  • GET /v1.0/studies/{studyId}/{mode}/querymgmt/filteredList
  • PUT /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/bulkCloseDelete
Deprecated
  • POST /v1.0/studies/{studyId}/{mode}/querymgmt/openQueryList
  • POST /v1.0/studies/{studyId}/{mode}/querymgmt/queryList
  • GET /v10.0/studies/{studyId}/{mode}/openQueryDetails
  • GET /v10.0/studies/{studyId}/{mode}/queryDetails
  • GET /v8.0/studies/{studyId}/{mode}/openQueryDetails
  • POST /v8.0/studies/{studyId}/{mode}/queries/candidate
  • POST /v8.0/studies/{studyId}/{mode}/queries/open
  • GET /v8.0/studies/{studyId}/{mode}/queries/{queryId}
  • PUT /v8.0/studies/{studyId}/{mode}/queries/{queryId}/answer
  • PUT /v8.0/studies/{studyId}/{mode}/queries/{queryId}/close
  • PUT /v8.0/studies/{studyId}/{mode}/queries/{queryId}/delete
  • PUT /v8.0/studies/{studyId}/{mode}/queries/{queryId}/open
  • GET /v8.0/studies/{studyId}/{mode}/queryDetails
  • GET /v9.0/studies/{studyId}/{mode}/openQueryDetails
  • PUT /v9.0/studies/{studyId}/{mode}/queries/{queryId}/close
  • GET /v9.0/studies/{studyId}/{mode}/queryDetails
  • POST /v9.0/studies/{studyId}/{mode}/report/{reportName}

Rule designer

Note:

Rule Designer endpoints are listed under the Rules category.
Change Endpoint
New
  • PUT /v5.0/rule/studies/{studyId}/{mode}/bulkupdate
  • GET /v5.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
  • PUT /v6.0/rule/studies/{studyId}/{mode}/bulkupdate
  • GET /v6.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
  • PUT /v7.0/rule/studies/{studyId}/{mode}/bulkupdate
Deleted
  • POST /v1.0/rule/studies/{studyId}/{mode}/copy
  • PUT /v1.0/rule/studies/{studyId}/{mode}/from/{fromState}/to/{toState}/bulkstateupdate
  • POST /v1.0/rulemgt/studies/{studyId}/{mode}/filteredlist
Deprecated
  • POST /v1.0/rule/studies/{studyId}/{mode}/ruleIds/operands
  • GET /v3.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
  • PUT /v4.0/rule/studies/{studyId}/{mode}/bulkupdate

Rules

Change Endpoint
Deleted
  • PUT /v1.0/studies/{studyId}/{mode}/debugRule
  • PUT /v2.0/studies/{studyId}/{mode}/deleteform