Rest API updates

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

Permissions

• The ec-designer-ors-svc permission has been added to access some APIs of the Designer category.

Services updates

The following new service has been added:

• Designer ORS

The following services are updated:

• Data Action
• Data Capture
• Data Hub
• Data Integration
• Designer
• Designer EDC
• Randomization and Supplies
• Reporting
• Sites and Depots

Designer ORS

Note:

Designer ORS endpoints are listed under the Designer category.

Change	Endpoint
New	POST /v10.0/studies/{studyId}/versions/{version}/kits GET /v10.0/studies/{studyId}/versions/{version}/kits GET /v10.0/studies/{studyId}/versions/{version}/kits/{kitId} PUT /v10.0/studies/{studyId}/versions/{version}/kits/{kitId} DELETE /v10.0/studies/{studyId}/versions/{version}/kits/{kitId} GET /v6.0/studies/{studyId}/kits

Data Action

Change	Endpoint
New	POST /v1.0/studies/{studyId}/{mode}/subjects/visits/lock

Data Capture

Change	Endpoint
New	GET /v1/studies/{studyId}/{mode}/subjects/{subjectId}/{studyVersion}/demographicstatus GET /v7.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements

Data Hub

Change

Endpoint

New

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

Data Integration

Change	Endpoint
New	GET /v2.0/studies/{studyId}/{mode}/dataelements/all GET /v3.0/studies/{studyId}/{mode}/subjects/history/all GET /v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Designer

Change	Endpoint
New	POST /v2.0/studies/{studyId}/versions/{version}/forms/copyForms

Designer EDC

Note:

Designer EDC endpoints are listed under the Designer category.

Change	Endpoint
New	POST /v1.0/studies/{studyId}/visitsforms/actionitems

Randomization and Supplies

Change	Endpoint
New	PUT /v1.0/studies/{studyId}/{mode}/nsinventory POST /v1.0/studies/{studyId}/{mode}/nsinventory/audit GET /v1.0/studies/{studyId}/{mode}/nsinventory/kit-types/{kitTypeId}/kits POST /v1.0/studies/{studyId}/{mode}/nsinventory/lots/{lotId} GET /v1.0/studies/{studyId}/{mode}/nsinventory/lots/{lotId}/quantity PUT /v1.0/studies/{studyId}/{mode}/nsinventory/{nsinventoryId} GET /v1.0/studies/{studyId}/{mode}/nsinventorystatuses/allowed/{fromInventoryStatusId} GET /v1.0/studies/{studyId}/{mode}/orders-nsinventory POST /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/replaceRand GET /v10.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history GET /v16.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v2.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits PUT /v2.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits GET /v2.0/studies/{studyId}/{mode}/events/kitreplacement/{eventId} GET /v2.0/studies/{studyId}/{mode}/orders-inventory/audit POST /v2.0/studies/{studyId}/{mode}/reports/blinded-titration-summary POST /v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits POST /v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/receive-quarantined POST /v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits GET /v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history GET /v3.0/studies/{studyId}/{mode}/events/codebreak/{eventId} POST /v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received POST /v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak POST /v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview GET /v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits GET /v4.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits POST /v4.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits POST /v5.0/studies/{studyId}/{mode}/reports/subjects GET /v5.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits PUT /v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits GET /v5.0/studies/{studyId}/{mode}/unblinded-disp-history GET /v7.0/studies/{studyId}/{mode}/inventory/kit-types GET /v8.0/studies/{studyId}/{mode}/orders GET /v8.0/studies/{studyId}/{mode}/orders/{shipmentId} GET /v8.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Deprecated	GET /v1.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits GET /v1.0/studies/{studyId}/{mode}/inventory/kitDetails POST /v1.0/studies/{studyId}/{mode}/inventory/kits/audit GET /v1.0/studies/{studyId}/{mode}/orders GET /v1.0/studies/{studyId}/{mode}/orders-inventory/audit GET /v1.0/studies/{studyId}/{mode}/orders/{shipmentId} POST /v10.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v10.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v11.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v11.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v12.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v12.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v13.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v13.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v14.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v14.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v15.0/studies/{studyId}/{mode}/visits/subjectvisit POST /v16.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v2.0/studies/{studyId}/{mode}/inventory/kit-types GET /v2.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits POST /v2.0/studies/{studyId}/{mode}/inventory/kits/audit GET /v2.0/studies/{studyId}/{mode}/orders GET /v2.0/studies/{studyId}/{mode}/orders/{shipmentId} GET /v3.0/studies/{studyId}/{mode}/inventory/kit-types GET /v3.0/studies/{studyId}/{mode}/orders GET /v3.0/studies/{studyId}/{mode}/orders/{shipmentId} GET /v4.0/studies/{studyId}/{mode}/inventory/kit-types GET /v4.0/studies/{studyId}/{mode}/orders GET /v4.0/studies/{studyId}/{mode}/orders/{shipmentId} GET /v5.0/studies/{studyId}/{mode}/inventory/kit-types GET /v5.0/studies/{studyId}/{mode}/orders GET /v5.0/studies/{studyId}/{mode}/orders/{shipmentId} GET /v6.0/studies/{studyId}/{mode}/orders GET /v6.0/studies/{studyId}/{mode}/orders/{shipmentId} GET /v6.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history GET /v7.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history GET /v8.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history POST /v9.0/studies/{studyId}/{mode}/visits/subjectvisit GET /v9.0/studies/{studyId}/{mode}/visits/subjectvisit

Reporting

Change

Endpoint

Deleted

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 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	POST /v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals/bulkLookUp GET /v2.0/contacts GET /v2.0/organizations GET /v2.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType} GET /v3.0/studies/{studyId}/{mode}/labs

• Rest API patch updates
  See the newly added, deprecated, and deleted endpoints in Oracle Clinical One Platform 24.2.1.