Rest API updates

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

Permissions

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

Services updates

The following service is added:

• Designer EDC

The following services are updated:

• Codelist
• Data Action
• Data Hub
• Data Integration
• Data Capture
• Designer
• File Upload
• Notifications
• Library
• Randomization and Supplies
• Query
• Rule Designer
• Sites and Depots

Designer EDC

Note:

Designer EDC endpoints are listed under the Designer category.

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

Codelist

Change	Endpoint
Deleted	DELETE /v2.0/codelist/code/{codeId}

Data Action

Change	Endpoint
New	GET /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/validate/dataelements
Deprecated	GET /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks GET /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements

Data Hub

Change

Endpoint

New

POST /v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits POST /v2.0/tenant/{tenantId}/studies/{studyId}/codelists POST /v3.0/tenant/{tenantId}/studies/{studyId}/dataCollection POST /v3.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations POST /v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries POST /v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits POST /v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits POST /v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms POST /v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems POST /v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits

Data Integration

Change	Endpoint
New	PUT /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/formStatus GET /v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId} GET /v2.0/studies/{studyId}/{mode}/subjects/history/all GET /v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Data Capture

Change	Endpoint
New	GET /v1.0/studies/{studyId}/{mode}/subjects/screeningnumber PUT /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/randomizationnumber/{randNumber} GET /v1.0/studies/{studyId}/{mode}/svf PUT /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/undoSubject POST /v11.0/studies/{studyId}/{mode}/visitstatus/subjects POST /v3.0/studies/{studyId}/{mode}/subjects/migratesubject POST /v4.0/studies/{studyId}/{mode}/dataelements/multiple GET /v4.0/studies/{studyId}/{mode}/subjects GET /v8.0/studies/{studyId}/{mode}/visitstatus GET /v9.0/studies/{studyId}/{mode}/subjects/history/{subjectId} PUT /v9.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Deprecated	PUT /v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId} POST /v1.0/studies/{studyId}/{mode}/visit/verify/history GET /v1/studies/{studyId}/{mode}/subjects/history/all GET /v1/studies/{studyId}/{mode}/subjects/history/{subjectId} POST /v1/studies/{studyId}/{mode}/subjects/migratesubject POST /v1/studies/{studyId}/{mode}/subjects/visitschedule GET /v1/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId} POST /v10.0/studies/{studyId}/{mode}/visitstatus/subjects POST /v2.0/studies/{studyId}/{mode}/dataelements/verify GET /v2.0/studies/{studyId}/{mode}/subjects/history/all POST /v2.0/studies/{studyId}/{mode}/subjects/visitschedule POST /v3.0/studies/{studyId}/{mode}/dataelements/freeze GET /v3.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId} GET /v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId} GET /v4.0/studies/{studyId}/{mode}/subjects/history/all GET /v4.0/studies/{studyId}/{mode}/subjects/history/{subjectId} GET /v5.0/studies/{studyId}/{mode}/subjects/history/{subjectId} GET /v6.0/studies/{studyId}/{mode}/subjects/history/{subjectId} POST /v7.0/studies/{studyId}/{mode}/dataelements GET /v7.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} PUT /v7.0/studies/{studyId}/{mode}/dataelements/{dataElementId} PUT /v7.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} PUT /v8.0/studies/{studyId}/{mode}/dataelements/{dataElementId} POST /v8.0/studies/{studyId}/{mode}/visitstatus/subjects PUT /v8.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId} GET /v9.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId} PUT /v9.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Designer

Change	Endpoint
New	GET /v1.0/studies/{studyId}/versions/{version}/forms/{formId}/formLogo GET /v5.0/studies/{studyId}/kits POST /v7.0/studies/{studyId}/versions/{version}/kits GET /v7.0/studies/{studyId}/versions/{version}/kits GET /v7.0/studies/{studyId}/versions/{version}/kits/{kitId} POST /v9.0/studies/{studyId}/versions/{version}/kits GET /v9.0/studies/{studyId}/versions/{version}/kits GET /v9.0/studies/{studyId}/versions/{version}/kits/{kitId} PUT /v9.0/studies/{studyId}/versions/{version}/kits/{kitId} DELETE /v9.0/studies/{studyId}/versions/{version}/kits/{kitId} GET /v9.0/studies/{studyId}/versions/{version}/visits
Re-instated	POST /v1.0/report/{reportName} POST /v2.0/report/{reportName}

File Upload

Change	Endpoint
Deleted	POST /v3.0/storage/{bucketName}/{objectName}

Notifications

Change	Endpoint
Deprecated	POST /v1.0/studies/{studyId}/{mode}/notificationlog GET /v1.0/studies/{studyId}/{mode}/notificationlog POST /v2.0/studies/{studyId}/{mode}/notificationlog POST /v3.0/studies/{studyId}/{mode}/notificationlog

Library

Change	Endpoint
New	POST /v1.0/libraryObjects/kits GET /v1.0/libraryObjects/kits POST /v1.0/libraryObjects/kits/bulk/{status} GET /v1.0/libraryObjects/kits/pagination GET /v1.0/libraryObjects/kits/{libraryKitId} PUT /v1.0/libraryObjects/kits/{libraryKitId} DELETE /v1.0/libraryObjects/kits/{libraryKitId} GET /v1.0/libraryObjects/kits/{libraryKitId}/history

Randomization and Supplies

Change

Endpoint

New

GET /v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits PUT /v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits GET /v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits/{inventoryId}/historyById POST /v1.0/studies/{studyId}/{mode}/locally-sourced-kits GET /v1.0/studies/{studyId}/{mode}/locally-sourced-kits GET /v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id} PUT /v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id} DELETE /v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id} POST /v1.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits GET /v1.0/studies/{studyId}/{mode}/subject/{subjectId}/details GET /v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/locally-sourced-kits POST /v1.0/studies/{studyId}/{mode}/visits/subjectvisits2s POST /v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots PUT /v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id} GET /v3.0/studies/{studyId}/{mode}/kitlists GET /v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots GET /v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id} POST /v3.0/studies/{studyId}/{mode}/resupply/manual GET /v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits GET /v5.0/studies/{studyId}/{mode}/shipments GET /v7.0/studies/{studyId}/{mode}/orders GET /v7.0/studies/{studyId}/{mode}/orders/{shipmentId}

Query

Change	Endpoint
New	PUT /v9.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
Deprecated	PUT /v2.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate

Rule Designer

Note:

Rule Designer endpoints are listed under the Rules category.

Change	Endpoint
New	POST /v1.0/rulemgt/studies/{studyId}/{mode}/filteredlist PUT /v1.0/rulemgt/studies/{studyId}/{mode}/{publishRun} GET /v1.0/rulemgt/studies/{studyId}/{ruleId}/rulehistory GET /v2.0/rule/studies/{studyId}/{mode}/simple POST /v6.0/studies/{studyId}/{mode}/report/{reportName}

Sites and Depots

Change	Endpoint
New	GET /v1.0/addresses POST /v1.0/contacts GET /v1.0/contacts DELETE /v1.0/contacts/contact/{contactId} PUT /v1.0/contacts/deleteContact/{id} POST /v1.0/contacts/validateFields GET /v1.0/contacts/{contactId} PUT /v1.0/contacts/{contactId} PUT /v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage PUT /v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage/all GET /v1.0/entitymanagement/studyentities/{entityType}/{tenantEntityId}/details GET /v1.0/entitymanagement/tenantentities/{entityType}/{tenantEntityId}/details POST /v1.0/facilities/{InstitutionId} GET /v1.0/facilities/{InstitutionId} PUT /v1.0/facilities/{InstitutionId} POST /v1.0/organizations GET /v1.0/organizations PUT /v1.0/organizations/deleteOrganization/{id} POST /v1.0/organizations/validateFields GET /v1.0/organizations/{id} PUT /v1.0/organizations/{id} DELETE /v1.0/organizations/{id} POST /v1.0/sdfs/migration GET /v1.0/sdfs/migration/{tenantId}/status POST /v1.0/studies/{studyId}/{mode}/report/{reportName} GET /v1.0/studies/{studyId}/{mode}/sdfs/depot/{pathAttr} POST /v1.0/studies/{studyId}/{mode}/sdfs/extendedProperties PUT /v1.0/studies/{studyId}/{mode}/sdfs/extendedProperties POST /v1.0/studies/{studyId}/{mode}/sdfs/globalProperties PUT /v1.0/studies/{studyId}/{mode}/sdfs/globalProperties DELETE /v1.0/studies/{studyId}/{mode}/sdfs/globalProperties/{propId} GET /v1.0/studies/{studyId}/{mode}/sdfs/globalProperties/{propName} POST /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType} GET /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType} POST /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId} GET /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId} PUT /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId} PUT /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{kitTypeId}/shipToAddress POST /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId} GET /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId} PUT /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId} GET /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId} PUT /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId} DELETE /v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId} DELETE /v1.0/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId} GET /v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/kitSettings/{kitTypeId} GET /v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/locallySourced GET /v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/sdfRegion/{sdfId} PUT /v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/status DELETE /v1.0/tenantsite/associations/{associationId} GET /v1.0/tenantsite/associations/{associationId}/addresses POST /v1.0/tenantsite/associations/{associationId}/studySites GET /v1.0/tenantsite/associations/{associationId}/studySites GET /v1.0/tenantsite/{associationType}/associations POST /v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations GET /v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations PUT /v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations POST /v2.0/studies/{studyId}/{mode}/labs GET /v2.0/studies/{studyId}/{mode}/labs POST /v2.0/studies/{studyId}/{mode}/labs/siteslabs PUT /v2.0/studies/{studyId}/{mode}/labs/{studyLabId} DELETE /v2.0/studies/{studyId}/{mode}/siteslabs POST /v3.0/studies/{studyId}/{mode}/report/{reportName}
Deprecated	POST /v1.0/studies/{studyId}/{mode}/labs PUT /v1.0/studies/{studyId}/{mode}/labs/{id} DELETE /v1.0/studies/{studyId}/{mode}/labs/{id} POST /v1.0/studies/{studyId}/{mode}/siteslabs DELETE /v1.0/studies/{studyId}/{mode}/siteslabs POST /v1/studies/{studyId}/{mode}/sdfs DELETE /v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail POST /v1/studies/{studyId}/{mode}/sdfs/sdf PUT /v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId} PUT /v1/studies/{studyId}/{mode}/sdfs/{sdfId} DELETE /v1/studies/{studyId}/{mode}/sdfs/{sdfId} POST /v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address PUT /v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId} DELETE /v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId} POST /v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property PUT /v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId} DELETE /v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}