Rest API updates

See the newly added and newly deprecated endpoints of the Oracle Clinical One Platform APIs, available upon the Production release.

The following service has been added:

• Comment

The following services have been updated:

• Codelist
• Data Action
• Data Hub
• Data Capture
• Designer
• Library
• Query
• Randomization and Supplies
• Reporting
• Sites and Depots
• Users, Permissions, and Roles

Comment

Change

Endpoint

New

POST /v1.0/studies/{studyId}/comments POST /v1.0/studies/{studyId}/comments/markAsRead POST /v1.0/studies/{studyId}/comments/markAsUnRead POST /v1.0/studies/{studyId}/comments/objects POST /v1.0/studies/{studyId}/comments/objects/unreadCount GET /v1.0/studies/{studyId}/comments/objects/{objectId} GET /v1.0/studies/{studyId}/comments/objects/{objectId}/unreadCount PUT /v1.0/studies/{studyId}/comments/{commentId} DELETE /v1.0/studies/{studyId}/comments/{commentId}

Codelist

Change	Endpoint
New	GET /v1.0/history/codes GET /v1.0/history/codevalues GET /v1.0/history/groups

Data Action

Change

Endpoint

New

POST /v1.0/studies/{studyId}/{mode}/dataelements/freeze GET /v1.0/studies/{studyId}/{mode}/dataelements/sdv POST /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/lock/allvisit POST /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/validate/multiplevisits GET /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements POST /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/lock POST /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlock POST /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlockvisits PUT/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId} POST /v1.0/studies/{studyId}/{mode}/validate/multipleitems GET /v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks

Data Hub

Change

Endpoint

New

POST /v1.0/tenant/{tenantId}/codelists POST /v1.0/tenant/{tenantId}/studies/{studyId}/codelists POST /v2.0/tenant/{tenantId}/studies/{studyId}/dataCollection POST /v2.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations GET /v4.0/studies/{studyId}/{mode}/odm/metadata POST /v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries POST /v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects POST /v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits GET /v6.0/studies/{studyId}/{mode}/odm/clinicalData/blinded GET /v6.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded POST /v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits POST /v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms POST /v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems POST /v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits

Data Capture

Change	Endpoint
New	GET /v1.0/studies/{studyId}/{mode}/subjects/count GET /v1.0/studies/{studyId}/{mode}/dataelements/{dataelementId}/{opeartionType}/childItems PUT /v1/studies/{studyId}/{mode}/subjects/{subjectId}/undoSubject PUT /v11.0/studies/{studyId}/{mode}/dataelements/{dataElementId} POST /v12.0/studies/{studyId}/{mode}/visitstatus/subjects POST /v2.0/studies/{studyId}/{mode}/visitstatus/multiple POST /v3.0/studies/{studyId}/{mode}/subjects/visitschedule POST /v4.0/studies/{studyId}/{mode}/subjects/randomizeordispense POST /v4.0/studies/{studyId}/{mode}/subjects/visitschedule PUT /v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}/clearruleerror/{message}
Deprecated	GET /v1/studies/{studyId}/{mode}/dataelements/sdv POST /v2.0/studies/{studyId}/{mode}/dataelements/freeze PUT /v2.0/studies/{studyId}/{mode}/unfreeze/{dataElementId} POST /v1.0/studies/{studyId}/{mode}/asynch/report/{reportName} POST /v1/studies/{studyId}/{mode}/report/{reportName} POST /v1.0/studies/{studyId}/{mode}/report/{reportName} POST /v1.0/studies/{studyId}/{mode}/reports/{reportName} POST /v2.0/studies/{studyId}/{mode}/report/{reportName} POST /v3.0/studies/{studyId}/{mode}/report/{reportName} POST /v4.0/studies/{studyId}/{mode}/report/{reportName}

Designer

Change	Endpoint
New	GET /v1.0/studies/{studyId}/versions/{versionId}/cohorts GET /v2.0/studies/library/{libraryId}/studyType/{studyType}/studyUses GET /v2.0/studies/{studyId}/approved/choiceoptions GET /v2.0/studies/{studyId}/approved/objectids POST /v2.0/studies/{studyId}/forms/formitems GET /v2.0/studies/{studyId}/forms/{formId}/formitems GET /v2.0/studies/{studyId}/forms/{formId}/itemhistory GET /v2.0/studies/{studyId}/objectids GET /v2.0/studies/{studyId}/randomizationfactors GET /v2.0/studies/{studyId}/versions/{version}/forms/numericItems GET /v2.0/studies/{studyId}/visitsforms GET /v2.0/studies/{studyId}/{mode}/forms POST /v3.0/studies/{studyId}/lockObjectDetails GET /v3.0/studies/{studyId}/{mode}/forms POST /v4.0/studies/{studyId}/allForms/coding GET /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule POST /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId} PUT /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId} DELETE /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId} POST /v5.0/studies/{studyId}/allForms GET /v6.0/studies/{studyId}/studyversionobjects GET /v7.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings GET /v7.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo GET /v8.0/studies/{studyId}/studyDesign POST /v8.0/studies/{studyId}/studyDesign/paginated POST /v8.0/studies/{studyId}/versions/{version}/kits GET /v8.0/studies/{studyId}/versions/{version}/kits GET /v8.0/studies/{studyId}/versions/{version}/kits/{kitId} DELETE /v8.0/studies/{studyId}/versions/{version}/kits/{kitId} GET /v8.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings GET /v8.0/studies/{studyId}/versions/{version}/visitschedules POST /v9.0/studies/{studyId}/design POST /v9.0/studies/{studyId}/studyDesign GET /v9.0/studies/{studyId}/versions/{version}/design POST /v9.0/studies/{studyId}/versions/{version}/visits GET /v9.0/studies/{studyId}/versions/{version}/visits/{visitid} PUT /v9.0/studies/{studyId}/versions/{version}/visits/{visitid} DELETE /v9.0/studies/{studyId}/versions/{version}/visits/{visitid}
Deprecated	POST /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule PUT /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule DELETE /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule POST/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule PUT /v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule DELETE /v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule

Library

Change	Endpoint
New	GET /v1.0/libraryHistory/{libraryId} POST /v1.0/libraryObjects/studies/{studyId}/versions/{studyVersion}/revertCopyObjects POST /v2.0/libraryObjects GET /v2.0/libraryObjects DELETE /v2.0/libraryObjects POST /v2.0/libraryObjects/bulk GET /v2.0/libraryObjects/pagination POST /v2.0/libraryObjects/studies/{studyId}/versions/{studyVersion}/{copyObjectMethod}/copyObjects POST /v2.0/libraryObjects/updateStudyVersion PUT /v2.0/libraryUses GET /v2.0/libraryUses/library/{libraryId}/studyType/{studyType} GET /v2.0/libraryUses/studies/{studyId}/versions/{studyVersion} GET /v2.0/libraryUses/study/{studyId}/studyType/{studyType}
Deprecated	GET /v1.0/libraryObjects/{libraryId}

Query

Change	Endpoint
New	PUT /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/bulkCloseDelete

Randomization and Supplies

Change

Endpoint

New

POST /v1.0/studies/{studyId}/{mode}/reports/locallysourcedkits GET /v15.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v16.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v2.0/studies/{studyId}/{mode}/reports/unblinded-visit-schedule POST /v3.0/studies/{studyId}/{mode}/reports/kits/blindedInventory POST /v3.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody POST /v3.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory POST /v4.0/studies/{studyId}/{mode}/reports/order-summary POST /v4.0/studies/{studyId}/{mode}/reports/subjects GET /v4.0/studies/{studyId}/{mode}/shipments POST /v5.0/studies/{studyId}/{mode}/reports/order-summary GET /v6.0/studies/{studyId}/{mode}/orders GET /v6.0/studies/{studyId}/{mode}/orders/{shipmentId} POST /v7.0/studies/{studyId}/{mode}/reports/kits/chainofcustody

Reporting

Change	Endpoint
New	POST /v2.0/scheduled/reports
Deprecated	GET/v1.0/reportmetadata/downloadList GET /v1.0/reportmetadata/reportId/{id} GET /v1.0/reports/download POST /v1.0/reports/page GET /v1.0/studies/{studyId}/{mode}/reportmetadata/reportId/{id} POST /v1.0/studies/{studyId}/{mode}/reports DELETE /v1.0/studies/{studyId}/{mode}/reports GET /v1.0/studies/{studyId}/{mode}/reports/download POST /v2.0/reports/page GET /v2.0/studies/{studyId}/{mode}/reports/download

Sites and Depots

Change	Endpoint
New	GET /v2.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals PUT /v2.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals GET /v2.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals/lookup GET /v5.0/studies/{studyId}/{mode}/sdfcountry

Users, Permissions and Roles

Change	Endpoint
New	GET /v1.0/userinfo/bulk GET/v2.0/userinfo/bulk