Rest API updates
See what has been updated in the Oracle Clinical One Platform API.
Code list
Change | Method | Endpoint |
---|---|---|
New |
|
/v2.0/codelist/code/{codeId} |
|
/v3.0/codelist/code/{codeId} |
|
Deprecated |
|
/v1.0/codelist/values/{fieldName} |
|
/v2.0/codelist |
|
|
/v2.0/codelist/code |
|
|
/v2.0/codelist/code/{codeId} |
|
|
/v2.0/codelist/history/{name} |
|
|
/v2.0/codelist/{name} |
|
|
/v3.0/codelist |
|
|
/v3.0/codelist/{name} |
Coding
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/studies/{studyId}/{mode}/subjectNumberChange |
Data Action
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/studies/{studyId}/{mode}/lockedstatus |
|
/v1.0/studies/{studyId}/{mode}/cleardatacheck/{scope} |
|
|
/v1.0/studies/{studyId}/{mode}/subjects-with-locked-data |
|
|
/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks |
|
|
/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks |
|
|
/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/all |
|
|
/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/visits |
|
|
/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/unlocks |
|
|
/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/multipleitems/locks |
|
|
/v1.0/studies/{studyId}/{mode}/unsign-unverify |
Data Hub
Change | Method | Endpoint |
---|---|---|
New |
|
/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits |
|
/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits |
|
|
/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits |
Data Integration
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/studies/{studyId}/{mode}/lockedstatus |
Data Capture
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/studies/{studyId}/{mode}/dataelements/clear/{scope} |
|
/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata |
|
|
/v1/studies/{studyId}/{mode}/subjects/subjectnumber |
|
|
/v10.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v10.0/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v10.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v10.0/studies/{studyId}/{mode}/visitstatus/subjects |
|
|
/v10.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements/{dataelementId} |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/dateRange |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/history/all |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/visitschedule |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId} |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/randomizeordispense |
|
|
/v4.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId} |
|
|
/v6.0/studies/{studyId}/{mode}/subjects/history/{subjectId} |
|
|
/v7.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId} |
|
|
/v8.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber |
|
|
/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber |
|
Deprecated |
|
/v1.0/studies/{studyId}/{mode}/dataelements/freeze |
|
/v1.0/studies/{studyId}/{mode}/dataelements/verify |
|
|
/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId} |
|
|
/v1/studies/{studyId}/{mode}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/dataelements/all |
|
|
/v1/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v1/studies/{studyId}/{mode}/dataelements/multiple |
|
|
/v1/studies/{studyId}/{mode}/dataelements/multirepeatingform |
|
|
/v1/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId} |
|
|
/v1/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items |
|
|
/v1/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v1/studies/{studyId}/{mode}/forms/{formId}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations |
|
|
/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements |
|
|
/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements |
|
|
/v1/studies/{studyId}/{mode}/subjects |
|
|
/v1/studies/{studyId}/{mode}/subjects |
|
|
/v1/studies/{studyId}/{mode}/subjects/dateRange/{subjectId} |
|
|
/v1/studies/{studyId}/{mode}/subjects/randomizeordispense |
|
|
/v1/studies/{studyId}/{mode}/subjects/sitestudyversion |
|
|
/v1/studies/{studyId}/{mode}/subjects/state/{subjectId} |
|
|
/v1/studies/{studyId}/{mode}/subjects/{subjectId} |
|
|
/v1/studies/{studyId}/{mode}/subjects/{subjectId} |
|
|
/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak |
|
|
/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codeview |
|
|
/v1/studies/{studyId}/{mode}/subjectsettings |
|
|
/v1/studies/{studyId}/{mode}/subjectsettings |
|
|
/v1/studies/{studyId}/{mode}/subjecttransfers |
|
|
/v1/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId} |
|
|
/v1/studies/{studyId}/{mode}/subjecttransfers/{transferId} |
|
|
/v1/studies/{studyId}/{mode}/visitstatus |
|
|
/v1/studies/{studyId}/{mode}/visitstatus |
|
|
/v1/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId} |
|
|
/v1/studies/{studyId}/{mode}/visitstatus/subjects |
|
|
/v1/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements/multiple |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId} |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items |
|
|
/v2.0/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v2.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements |
|
|
/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations |
|
|
/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements |
|
|
/v2.0/studies/{studyId}/{mode}/subjects |
|
|
/v2.0/studies/{studyId}/{mode}/subjects |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId} |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/randomizeordispense |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/sitestudyversion |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/{subjectId} |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/{subjectId} |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak |
|
|
/v2.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId} |
|
|
/v2.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v2.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v2.0/studies/{studyId}/{mode}/visitstatus/dateRange |
|
|
/v2.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId} |
|
|
/v2.0/studies/{studyId}/{mode}/visitstatus/subjects |
|
|
/v2.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v3.0/studies/{studyId}/{mode}/dataelements |
|
|
/v3.0/studies/{studyId}/{mode}/dataelements |
|
|
/v3.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v3.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items |
|
|
/v3.0/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v3.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId} |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/sitestudyversion |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/{subjectId} |
|
|
/v3.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v3.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v3.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId} |
|
|
/v3.0/studies/{studyId}/{mode}/visitstatus/subjects |
|
|
/v3.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v4.0/studies/{studyId}/{mode}/dataelements |
|
|
/v4.0/studies/{studyId}/{mode}/dataelements |
|
|
/v4.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v4.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items |
|
|
/v4.0/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v4.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements |
|
|
/v4.0/studies/{studyId}/{mode}/subjects/sitestudyversion |
|
|
/v4.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v4.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v4.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId} |
|
|
/v4.0/studies/{studyId}/{mode}/visitstatus/subjects |
|
|
/v4.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v5.0/studies/{studyId}/{mode}/dataelements |
|
|
/v5.0/studies/{studyId}/{mode}/dataelements |
|
|
/v5.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v5.0/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v5.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements |
|
|
/v5.0/studies/{studyId}/{mode}/subjects/sitestudyversion |
|
|
/v5.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v5.0/studies/{studyId}/{mode}/visitstatus/subjects |
|
|
/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v6.0/studies/{studyId}/{mode}/dataelements |
|
|
/v6.0/studies/{studyId}/{mode}/dataelements |
|
|
/v6.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} |
|
|
/v6.0/studies/{studyId}/{mode}/dataelements/{dataElementId} |
|
|
/v6.0/studies/{studyId}/{mode}/eventsCount |
|
|
/v6.0/studies/{studyId}/{mode}/repeatInstanceNumbers |
|
|
/v6.0/studies/{studyId}/{mode}/subjects/sitestudyversion |
|
|
/v6.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} |
|
|
/v7.0/studies/{studyId}/{mode}/dataelements |
|
|
/v7.0/studies/{studyId}/{mode}/visitstatus |
|
|
/v8.0/studies/{studyId}/{mode}/dataelements |
Designer
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/studies/welcome |
|
/v1.0/studies/welcome |
|
|
/v1.0/studies/welcome |
|
|
/v1.0/studies/welcome |
|
|
/v4.0/studies/{studyId}/statuses |
|
|
/v4.0/studies/{studyId}/statuses/{version} |
|
|
/v1.0/studies/{studyId}/lockObjectDetails |
Notifications
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/i18support/email/{templatetype} |
Randomization and Supplies
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/studies/{studyId}/{mode}/events/resume_dosehold_dispensation/{eventId} |
|
/v1.0/studies/{studyId}/{mode}/events/resume_partial_dispensation/{eventId} |
|
|
/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById |
|
|
/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/lastStatusById |
|
|
/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings |
|
|
/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings |
|
|
/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id} |
|
|
/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id} |
|
|
/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id} |
|
|
/v1.0/studies/{studyId}/{mode}/reports/partialdispensations |
|
|
/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById |
|
|
/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/lastStatusById |
|
|
/v1.0/studies/{studyId}/{mode}/subject-partial-dispensations |
|
|
/v14.0/studies/{studyId}/{mode}/visits/subjectvisit |
|
|
/v14.0/studies/{studyId}/{mode}/visits/subjectvisit |
|
|
/v15.0/studies/{studyId}/{mode}/visits/subjectvisit |
|
|
/v2.0/studies/{studyId}/{mode}/barcode |
|
|
/v2.0/studies/{studyId}/{mode}/events/codebreak/{eventId} |
|
|
/v2.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/lastStatus |
|
|
/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits |
|
|
/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/lastStatus |
|
|
/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits |
|
|
/v3.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits |
|
|
/v3.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/history |
|
|
/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/history |
|
|
/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld |
|
|
/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits |
|
|
/v4.0/studies/{studyId}/{mode}/inventory/kit-types |
|
|
/v5.0/studies/{studyId}/{mode}/inventory/kit-types |
|
|
/v7.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits |
|
|
/v8.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history |
|
|
/v8.0/studies/{studyId}/{mode}/supply/settings |
|
|
/v9.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history |
|
Deprecated |
|
/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/history |
|
/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/lastStatus |
|
|
/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/lastStatus |
|
|
/v2.0/studies/{studyId}/{mode}/kits/{kitNumber}/history |
|
|
/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history |
Reporting
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/notification/{notificationType} |
Sites and Depots
Change | Method | Endpoint |
---|---|---|
New |
|
/v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail |
|
/v2/studies/{studyId}/{mode}/country/{countryId}/states |
|
|
/v2/studies/{studyId}/{mode}/sdfs/countries |
|
|
/v3/studies/{studyId}/{mode}/regions |
|
|
/v3/studies/{studyId}/{mode}/regions/{regionId} |
|
|
/v3/studies/{studyId}/{mode}/regions/{regionId}/countries |
|
|
/v3/studies/{studyId}/{mode}/sdfcountry |
|
|
/v4/studies/{studyId}/{mode}/country |
Users, Pemissions and Roles
Change | Method | Endpoint |
---|---|---|
New |
|
/v1.0/report/globalstudyrole/{reportName} |
|
/v2.0/{studyId}/{mode}/report/uploaderror/{reportName} |