Rest API updates

See what has been updated in the Oracle Clinical One Platform API.

The following services have been updated:

• Code list
• Coding
• Data Action
• Data Hub
• Data Integration
• Data Capture
• Designer
• Notifications
• Randomization and Supplies
• Reporting
• Sites and Depots
• Users, Permissions and Roles

Code list

Change	Method	Endpoint
New	DELETE	/v2.0/codelist/code/{codeId}
	PUT	/v3.0/codelist/code/{codeId}
Deprecated	GET	/v1.0/codelist/values/{fieldName}
	GET	/v2.0/codelist
	POST	/v2.0/codelist/code
	PUT	/v2.0/codelist/code/{codeId}
	GET	/v2.0/codelist/history/{name}
	GET	/v2.0/codelist/{name}
	GET	/v3.0/codelist
	GET	/v3.0/codelist/{name}

Coding

Change	Method	Endpoint
New	POST	/v1.0/studies/{studyId}/{mode}/subjectNumberChange

Data Action

Change	Method	Endpoint
New	GET	/v1.0/studies/{studyId}/{mode}/lockedstatus
	POST	/v1.0/studies/{studyId}/{mode}/cleardatacheck/{scope}
	GET	/v1.0/studies/{studyId}/{mode}/subjects-with-locked-data
	GET	/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks
	POST	/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks
	GET	/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/all
	GET	/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/visits
	POST	/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/unlocks
	POST	/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/multipleitems/locks
	PUT	/v1.0/studies/{studyId}/{mode}/unsign-unverify

Data Hub

Change	Method	Endpoint
New	POST	/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
	POST	/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
	POST	/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits

Data Integration

Change	Method	Endpoint
New	GET	/v1.0/studies/{studyId}/{mode}/lockedstatus

Data Capture

Change	Method	Endpoint
New	PUT	/v1.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
	GET	/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
	PUT	/v1/studies/{studyId}/{mode}/subjects/subjectnumber
	GET	/v10.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
	PUT	/v10.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
	GET	/v10.0/studies/{studyId}/{mode}/visitstatus
	POST	/v10.0/studies/{studyId}/{mode}/visitstatus/subjects
	PUT	/v10.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
	GET	/v2.0/studies/{studyId}/{mode}/dataelements/{dataelementId}
	GET	/v2.0/studies/{studyId}/{mode}/subjects/dateRange
	GET	/v2.0/studies/{studyId}/{mode}/subjects/history/all
	POST	/v2.0/studies/{studyId}/{mode}/subjects/visitschedule
	GET	/v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
	POST	/v3.0/studies/{studyId}/{mode}/subjects/randomizeordispense
	GET	/v4.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
	GET	/v6.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
	GET	/v7.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
	PUT	/v8.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
	PUT	/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber
	PUT	/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber
Deprecated	POST	/v1.0/studies/{studyId}/{mode}/dataelements/freeze
	POST	/v1.0/studies/{studyId}/{mode}/dataelements/verify
	POST	/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
	POST	/v1/studies/{studyId}/{mode}/dataelements
	GET	/v1/studies/{studyId}/{mode}/dataelements
	PUT	/v1/studies/{studyId}/{mode}/dataelements
	GET	/v1/studies/{studyId}/{mode}/dataelements/all
	GET	/v1/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
	POST	/v1/studies/{studyId}/{mode}/dataelements/multiple
	POST	/v1/studies/{studyId}/{mode}/dataelements/multirepeatingform
	GET	/v1/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
	GET	/v1/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
	PUT	/v1/studies/{studyId}/{mode}/dataelements/{dataElementId}
	GET	/v1/studies/{studyId}/{mode}/forms/{formId}/dataelements
	GET	/v1/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
	GET	/v1/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements
	GET	/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
	GET	/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
	DELETE	/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
	POST	/v1/studies/{studyId}/{mode}/subjects
	GET	/v1/studies/{studyId}/{mode}/subjects
	GET	/v1/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
	POST	/v1/studies/{studyId}/{mode}/subjects/randomizeordispense
	GET	/v1/studies/{studyId}/{mode}/subjects/sitestudyversion
	DELETE	/v1/studies/{studyId}/{mode}/subjects/state/{subjectId}
	GET	/v1/studies/{studyId}/{mode}/subjects/{subjectId}
	PUT	/v1/studies/{studyId}/{mode}/subjects/{subjectId}
	PUT	/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
	PUT	/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
	POST	/v1/studies/{studyId}/{mode}/subjectsettings
	GET	/v1/studies/{studyId}/{mode}/subjectsettings
	GET	/v1/studies/{studyId}/{mode}/subjecttransfers
	GET	/v1/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
	GET	/v1/studies/{studyId}/{mode}/subjecttransfers/{transferId}
	POST	/v1/studies/{studyId}/{mode}/visitstatus
	GET	/v1/studies/{studyId}/{mode}/visitstatus
	GET	/v1/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
	POST	/v1/studies/{studyId}/{mode}/visitstatus/subjects
	PUT	/v1/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
	POST	/v2.0/studies/{studyId}/{mode}/dataelements
	GET	/v2.0/studies/{studyId}/{mode}/dataelements
	GET	/v2.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
	POST	/v2.0/studies/{studyId}/{mode}/dataelements/multiple
	GET	/v2.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
	GET	/v2.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
	PUT	/v2.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
	GET	/v2.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
	GET	/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
	GET	/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
	POST	/v2.0/studies/{studyId}/{mode}/subjects
	GET	/v2.0/studies/{studyId}/{mode}/subjects
	GET	/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
	POST	/v2.0/studies/{studyId}/{mode}/subjects/randomizeordispense
	GET	/v2.0/studies/{studyId}/{mode}/subjects/sitestudyversion
	GET	/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
	PUT	/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
	PUT	/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
	GET	/v2.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
	POST	/v2.0/studies/{studyId}/{mode}/visitstatus
	GET	/v2.0/studies/{studyId}/{mode}/visitstatus
	GET	/v2.0/studies/{studyId}/{mode}/visitstatus/dateRange
	GET	/v2.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
	POST	/v2.0/studies/{studyId}/{mode}/visitstatus/subjects
	PUT	/v2.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
POST	/v3.0/studies/{studyId}/{mode}/dataelements
GET	/v3.0/studies/{studyId}/{mode}/dataelements
GET	/v3.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
GET	/v3.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
PUT	/v3.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
GET	/v3.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
GET	/v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
GET	/v3.0/studies/{studyId}/{mode}/subjects/sitestudyversion
GET	/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
POST	/v3.0/studies/{studyId}/{mode}/visitstatus
GET	/v3.0/studies/{studyId}/{mode}/visitstatus
GET	/v3.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
POST	/v3.0/studies/{studyId}/{mode}/visitstatus/subjects
PUT	/v3.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
POST	/v4.0/studies/{studyId}/{mode}/dataelements
GET	/v4.0/studies/{studyId}/{mode}/dataelements
GET	/v4.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
GET	/v4.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
PUT	/v4.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
GET	/v4.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
GET	/v4.0/studies/{studyId}/{mode}/subjects/sitestudyversion
POST	/v4.0/studies/{studyId}/{mode}/visitstatus
GET	/v4.0/studies/{studyId}/{mode}/visitstatus
GET	/v4.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
POST	/v4.0/studies/{studyId}/{mode}/visitstatus/subjects
PUT	/v4.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
POST	/v5.0/studies/{studyId}/{mode}/dataelements
GET	/v5.0/studies/{studyId}/{mode}/dataelements
GET	/v5.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
PUT	/v5.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
GET	/v5.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
GET	/v5.0/studies/{studyId}/{mode}/subjects/sitestudyversion
GET	/v5.0/studies/{studyId}/{mode}/visitstatus
POST	/v5.0/studies/{studyId}/{mode}/visitstatus/subjects
PUT	/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
POST	/v6.0/studies/{studyId}/{mode}/dataelements
GET	/v6.0/studies/{studyId}/{mode}/dataelements
GET	/v6.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
PUT	/v6.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
GET	/v6.0/studies/{studyId}/{mode}/eventsCount
GET	/v6.0/studies/{studyId}/{mode}/repeatInstanceNumbers
GET	/v6.0/studies/{studyId}/{mode}/subjects/sitestudyversion
GET	/v6.0/studies/{studyId}/{mode}/visitstatus
PUT	/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
GET	/v7.0/studies/{studyId}/{mode}/dataelements
GET	/v7.0/studies/{studyId}/{mode}/visitstatus
POST	/v8.0/studies/{studyId}/{mode}/dataelements

Designer

Change	Method	Endpoint
New	POST	/v1.0/studies/welcome
	GET	/v1.0/studies/welcome
	PUT	/v1.0/studies/welcome
	DELETE	/v1.0/studies/welcome
	GET	/v4.0/studies/{studyId}/statuses
	GET	/v4.0/studies/{studyId}/statuses/{version}
	POST	/v1.0/studies/{studyId}/lockObjectDetails

Notifications

Change	Method	Endpoint
New	POST	/v1.0/i18support/email/{templatetype}

Randomization and Supplies

Change	Method	Endpoint
New	GET	/v1.0/studies/{studyId}/{mode}/events/resume_dosehold_dispensation/{eventId}
	GET	/v1.0/studies/{studyId}/{mode}/events/resume_partial_dispensation/{eventId}
	GET	/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById
	GET	/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/lastStatusById
	POST	/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings
	GET	/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings
	GET	/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}
	PUT	/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}
	DELETE	/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}
	POST	/v1.0/studies/{studyId}/{mode}/reports/partialdispensations
	GET	/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
	GET	/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/lastStatusById
	POST	/v1.0/studies/{studyId}/{mode}/subject-partial-dispensations
	POST	/v14.0/studies/{studyId}/{mode}/visits/subjectvisit
	GET	/v14.0/studies/{studyId}/{mode}/visits/subjectvisit
	POST	/v15.0/studies/{studyId}/{mode}/visits/subjectvisit
	PUT	/v2.0/studies/{studyId}/{mode}/barcode
	GET	/v2.0/studies/{studyId}/{mode}/events/codebreak/{eventId}
	GET	/v2.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/lastStatus
	GET	/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
	GET	/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/lastStatus
	POST	/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
	GET	/v3.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
	GET	/v3.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/history
	GET	/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/history
	GET	/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
	POST	/v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
	GET	/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
	POST	/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
	GET	/v4.0/studies/{studyId}/{mode}/inventory/kit-types
	GET	/v5.0/studies/{studyId}/{mode}/inventory/kit-types
	GET	/v7.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
	GET	/v8.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
	PUT	/v8.0/studies/{studyId}/{mode}/supply/settings
	GET	/v9.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Deprecated	GET	/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
	GET	/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/lastStatus
	GET	/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/lastStatus
	GET	/v2.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
	GET	/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history

Reporting

Change	Method	Endpoint
New	POST	/v1.0/notification/{notificationType}

Sites and Depots

Change	Method	Endpoint
New	DELETE	/v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail
	GET	/v2/studies/{studyId}/{mode}/country/{countryId}/states
	GET	/v2/studies/{studyId}/{mode}/sdfs/countries
	GET	/v3/studies/{studyId}/{mode}/regions
	GET	/v3/studies/{studyId}/{mode}/regions/{regionId}
	GET	/v3/studies/{studyId}/{mode}/regions/{regionId}/countries
	GET	/v3/studies/{studyId}/{mode}/sdfcountry
	GET	/v4/studies/{studyId}/{mode}/country

Users, Pemissions and Roles

Change	Method	Endpoint
New	POST	/v1.0/report/globalstudyrole/{reportName}
	POST	/v2.0/{studyId}/{mode}/report/uploaderror/{reportName}