REST API updates

See the newly added, deprecated, and deleted endpoints in Oracle Clinical One Platform 26.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:

Codelist

Change Endpoint
New
  • POST /v1.0/codelist/dynamic/copy
  • GET /v1.0/codelist/values/asOfDate/{id}
  • GET /v4.0/codelist/values/{fieldName}
  • POST /v5.0/codelist/code
  • PUT /v5.0/codelist/code/{codeId}

Data Action

Change Endpoint
New
  • PUT /v1.0/studies/{studyId}/{mode}/unfreeze/vsd
  • GET /v1.0/studies/{studyId}/{mode}/visit/sdv
  • PUT /v2.0/studies/{studyId}/{mode}/unsign-unverifyforitem

Data Hub

Change Endpoint
New
  • GET /v10.0/studies/{studyId}/{mode}/odm/metadata
  • POST /v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
  • POST /v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
  • POST /v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
  • POST /v14.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v3.0/tenant/{tenantId}/studies/{studyId}/codelists
  • POST /v9.0/tenant/{tenantId}/studies/{studyId}/dataCollection
Deprecated
  • POST /v1.0/tenant/{tenantId}/studies/{studyId}/codelists
  • POST /v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
  • POST /v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
  • POST /v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • GET /v8.0/studies/{studyId}/{mode}/odm/metadata
  • POST /v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits

Data Capture

Change Endpoint
New
  • POST /v1.0/studies/{studyId}/{mode}/visit/freeze
  • POST /v1.0/studies/{studyId}/{mode}/visit/verify
  • PUT /v11.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
  • GET /v12.0/studies/{studyId}/{mode}/visitstatus
  • GET /v5.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
  • GET /v8.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Deleted
  • PUT /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/randomizationnumber/{randNumber}
  • PUT /v1/studies/{studyId}/{mode}/dataelements
  • GET /v6.0/studies/{studyId}/{mode}/eventsCount

Designer EDC

Change Endpoint
New
  • POST /v20.0/studies/{studyId}/versions/{version}/forms
  • GET /v20.0/studies/{studyId}/versions/{version}/forms
  • GET /v20.0/studies/{studyId}/versions/{version}/forms/unblinded
  • GET /v20.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
  • GET /v20.0/studies/{studyId}/versions/{version}/forms/{formId}
  • PUT /v20.0/studies/{studyId}/versions/{version}/forms/{formId}
  • DELETE /v20.0/studies/{studyId}/versions/{version}/forms/{formId}
  • GET /v20.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v3.0/studies/{studyId}/forms/{formId}/formitems
  • POST /v5.0/studies/{studyId}/lockObjectDetails

Designer

Change Endpoint
New
  • POST /v10.0/studies/{studyId}/versions/{version}/visits
  • GET /v10.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v10.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v10.0/studies/{studyId}/versions/{version}/visits/{visitid}

Randomization & Supplies

Change Endpoint
New
  • GET /v1.0/studies/{studyId}/{mode}/randlists
  • GET /v11.0/studies/{studyId}/{mode}/supply/settings
  • PUT /v11.0/studies/{studyId}/{mode}/supply/settings
  • GET /v3.0/studies/{studyId}/{mode}/settings/cohortlimits
  • PUT /v3.0/studies/{studyId}/{mode}/settings/cohortlimits
  • POST /v3.0/studies/{studyId}/{mode}/sites/{siteId}/resupply/manual
  • POST /v4.0/studies/{studyId}/{mode}/resupply/manual
Deprecated
  • GET /v1.0/studies/{studyId}/{mode}/events/codebreak/{eventId}
  • PUT /v1.0/studies/{studyId}/{mode}/inventory/kits
  • GET /v1.0/studies/{studyId}/{mode}/inventorystatuses
  • GET /v1.0/studies/{studyId}/{mode}/kits/{sourceId}/export
  • POST /v1.0/studies/{studyId}/{mode}/lots/blinded-lots
  • GET /v1.0/studies/{studyId}/{mode}/lots/blinded-lots
  • POST /v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • GET /v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • GET /v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • PUT /v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • GET /v1.0/studies/{studyId}/{mode}/randlistdesigns
  • POST /v1.0/studies/{studyId}/{mode}/reports/supplysettingsaudit
  • POST /v1.0/studies/{studyId}/{mode}/resupplies
  • GET /v1.0/studies/{studyId}/{mode}/resupplies
  • GET /v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
  • PUT /v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
  • GET /v1.0/studies/{studyId}/{mode}/settings/cohortlimits
  • PUT /v1.0/studies/{studyId}/{mode}/settings/cohortlimits
  • GET /v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
  • GET /v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
  • POST /v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
  • GET /v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
  • POST /v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
  • POST /v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
  • POST /v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
  • GET /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
  • GET /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
  • POST /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
  • GET /v1.0/studies/{studyId}/{mode}/unblinded-disp-history
  • POST /v1.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
  • GET /v15.0/studies/{studyId}/{mode}/visits/subjectvisit
  • PUT /v2.0/studies/{studyId}/{mode}/inventory/kits
  • GET /v2.0/studies/{studyId}/{mode}/inventorystatuses
  • GET /v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • GET /v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • GET /v2.0/studies/{studyId}/{mode}/randlists
  • GET /v2.0/studies/{studyId}/{mode}/randlists/{rndlistid}
  • GET /v2.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
  • POST /v2.0/studies/{studyId}/{mode}/resupply/manual
  • GET /v2.0/studies/{studyId}/{mode}/shipment-statuses
  • GET /v2.0/studies/{studyId}/{mode}/shipments
  • GET /v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}
  • GET /v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
  • GET /v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
  • PUT /v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
  • PUT /v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
  • GET /v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
  • GET /v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
  • POST /v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
  • POST /v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
  • GET /v2.0/studies/{studyId}/{mode}/unblinded-disp-history
  • GET /v3.0/studies/{studyId}/{mode}/randlists
  • GET /v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}
  • GET /v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
  • GET /v3.0/studies/{studyId}/{mode}/shipments
  • GET /v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
  • PUT /v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
  • PUT /v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
  • GET /v3.0/studies/{studyId}/{mode}/unblinded-disp-history
  • GET /v4.0/studies/{studyId}/{mode}/randlists
  • GET /v4.0/studies/{studyId}/{mode}/shipments
  • GET /v4.0/studies/{studyId}/{mode}/supply/settings
  • PUT /v4.0/studies/{studyId}/{mode}/supply/settings
  • GET /v5.0/studies/{studyId}/{mode}/randlists
  • GET /v5.0/studies/{studyId}/{mode}/shipments
  • GET /v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
  • GET /v5.0/studies/{studyId}/{mode}/supply/settings
  • PUT /v5.0/studies/{studyId}/{mode}/supply/settings
  • GET /v6.0/studies/{studyId}/{mode}/shipments
  • GET /v6.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
  • GET /v6.0/studies/{studyId}/{mode}/supply/settings
  • PUT /v6.0/studies/{studyId}/{mode}/supply/settings
  • GET /v7.0/studies/{studyId}/{mode}/orders
  • GET /v7.0/studies/{studyId}/{mode}/orders/{shipmentId}
  • PUT /v7.0/studies/{studyId}/{mode}/supply/settings
  • GET /v8.0/studies/{studyId}/{mode}/orders
  • GET /v8.0/studies/{studyId}/{mode}/orders/{shipmentId}
  • PUT /v8.0/studies/{studyId}/{mode}/supply/settings
  • GET /v9.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
  • PUT /v9.0/studies/{studyId}/{mode}/supply/settings

Site

Change Endpoint
New
  • GET /v1.0/studies/{studyId}/site/all
  • PUT /v3.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals

Parent topic: What's new in 26.1