Rest API updates

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

The following new service has been added:

• Library

The following services have been updated:

• Data Action
• Data Hub
• Data Capture
• Designer
• Notifications
• Query
• Randomization and Supplies
• Rules
• Rule Designer
• Users, Permissions and Roles

Library

Change	Method	Endpoint
New	GET	/v1.0/libraryUses/studies/{studyId}/versions/{studyVersion}

Data Action

Change	Method	Endpoint
New	PUT	/v1.0/studies/{studyId}/{mode}/unsign-unverifyforitem
	POST	/v2.0/studies/{studyId}/{mode}/cleardatacheck/{scope}

Data Hub

Change	Method	Endpoint
New	GET	/v3.0/studies/{studyId}/{mode}/odm/metadata
	POST	/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
	GET	/v5.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
	GET	/v5.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
	POST	/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems

Data Capture

Change	Method	Endpoint
New	PUT	/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
	GET	/v4.0/studies/{studyId}/{mode}/subjects/history/all
	PUT	/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}
	PUT	/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
	GET	/v5.0/studies/{studyId}/{mode}/subjects/{subjectId}
	GET	/v8.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Deprecated	POST	/v2.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}

Designer

Change	Method	Endpoint
New	POST	/v1.0/studies/{studyId}/cloneSystemCodelist
	POST	/v1.0/studies/{studyId}/forms/formitems
	POST	/v1.0/studies/{studyId}/forms/{formId}/choiceoptions
	GET	/v1.0/studies/{studyId}/forms/{formId}/formitems
	POST	/v1.0/studies/{studyId}/hasRandomization
	GET	/v1.0/studies/{studyId}/{mode}/forms
	GET	/v1.0/studies/{studyId}/{mode}/forms/{formId}/visits
	GET	/v5.0/studies/{studyId}/studyversionobjects
	POST	/v7.0/studies/{studyId}/studyDesign/paginated

Notifications

Change	Method	Endpoint
New	POST	/v5.0/studies/{studyId}/{mode}/notificationlog

Query

Change	Method	Endpoint
Deprecated	GET	/v1.0/studies/{studyId}/{mode}/queries/queryTable
	GET	/v1.0/studies/{studyId}/{mode}/queries/state
	PUT	/v1.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
	PUT	/v2.0/studies/{studyId}/{mode}/queries/{queryId}/answer
	PUT	/v2.0/studies/{studyId}/{mode}/queries/{queryId}/delete
	GET	/v2.0/studies/{studyId}/{mode}/queryDetails
	GET	/v3.0/studies/{studyId}/{mode}/openQueryDetails
	POST	/v3.0/studies/{studyId}/{mode}/queries/candidate
	POST	/v3.0/studies/{studyId}/{mode}/queries/open
	GET	/v3.0/studies/{studyId}/{mode}/queryDetails
	POST	/v3.0/studies/{studyId}/{mode}/report/{reportName}
	GET	/v4.0/studies/{studyId}/{mode}/openQueryDetails
	GET	/v4.0/studies/{studyId}/{mode}/queries/{queryId}
	PUT	/v4.0/studies/{studyId}/{mode}/queries/{queryId}/close
	PUT	/v4.0/studies/{studyId}/{mode}/queries/{queryId}/open
	POST	/v4.0/studies/{studyId}/{mode}/report/{reportName}
	GET	/v5.0/studies/{studyId}/{mode}/openQueryDetails
	POST	/v5.0/studies/{studyId}/{mode}/queries/candidate
	POST	/v5.0/studies/{studyId}/{mode}/queries/open
	PUT	/v5.0/studies/{studyId}/{mode}/queries/{queryId}/answer
	PUT	/v5.0/studies/{studyId}/{mode}/queries/{queryId}/close
	PUT	/v5.0/studies/{studyId}/{mode}/queries/{queryId}/delete
	PUT	/v5.0/studies/{studyId}/{mode}/queries/{queryId}/open
	GET	/v5.0/studies/{studyId}/{mode}/queryDetails
	POST	/v5.0/studies/{studyId}/{mode}/report/{reportName}
	GET	/v6.0/studies/{studyId}/{mode}/openQueryDetails
	POST	/v6.0/studies/{studyId}/{mode}/queries/candidate
	POST	/v6.0/studies/{studyId}/{mode}/queries/open
	GET	/v6.0/studies/{studyId}/{mode}/queries/{queryId}
	PUT	/v6.0/studies/{studyId}/{mode}/queries/{queryId}/answer
	PUT	/v6.0/studies/{studyId}/{mode}/queries/{queryId}/close
	PUT	/v6.0/studies/{studyId}/{mode}/queries/{queryId}/delete
	PUT	/v6.0/studies/{studyId}/{mode}/queries/{queryId}/open
	GET	/v6.0/studies/{studyId}/{mode}/queryDetails
	POST	/v6.0/studies/{studyId}/{mode}/report/{reportName}
	GET	/v7.0/studies/{studyId}/{mode}/openQueryDetails
	POST	/v7.0/studies/{studyId}/{mode}/queries/open
	GET	/v7.0/studies/{studyId}/{mode}/queries/{queryId}
	PUT	/v7.0/studies/{studyId}/{mode}/queries/{queryId}/answer
	PUT	/v7.0/studies/{studyId}/{mode}/queries/{queryId}/close
	PUT	/v7.0/studies/{studyId}/{mode}/queries/{queryId}/open
	GET	/v7.0/studies/{studyId}/{mode}/queryDetails
	POST	/v7.0/studies/{studyId}/{mode}/report/{reportName}

Randomization and Supplies

Change	Method	Endpoint
New	POST	/v1.0/studies/{studyId}/{mode}/reports/blindedrandreport
	GET	/v2.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById
	POST	/v2.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
	POST	/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined
	POST	/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
	GET	/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
	PUT	/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
	GET	/v4.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
	PUT	/v4.0/studies/{studyId}/{mode}/inventory/kits
	POST	/v4.0/studies/{studyId}/{mode}/inventory/kits/audit
	PUT	/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
	GET	/v5.0/studies/{studyId}/{mode}/orders
	GET	/v5.0/studies/{studyId}/{mode}/orders/{shipmentId}
	GET	/v6.0/studies/{studyId}/{mode}/inventory/kit-types
	POST	/v6.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
	PUT	/v9.0/studies/{studyId}/{mode}/supply/settings

Rules

Change	Method	Endpoint
Deprecated	PUT	/v1.0/studies/{studyId}/{mode}/jobStatus
	PUT	/v2.0/studies/{studyId}/{mode}/deleteform

Rule Designer

Change	Method	Endpoint
Deprecated	PUT	/v1.0/rule/studies/{studyId}/bulkcopy
	POST	/v1.0/rule/studies/{studyId}/copyrules
	PUT	/v1.0/rule/studies/{studyId}/{mode}/bulkupdate
	GET	/v1.0/rule/studies/{studyId}/{mode}/item/{itemId}
	GET	/v1.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
	GET	/v1.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
	POST	/v1.0/studies/{studyId}/{mode}/report/{reportName}
	PUT	/v2.0/rule/studies/{studyId}/bulkcopy
	PUT	/v2.0/rule/studies/{studyId}/{mode}/bulkupdate
	GET	/v2.0/rule/studies/{studyId}/{mode}/item/{itemId}
	GET	/v2.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
	GET	/v2.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
	POST	/v2.0/studies/{studyId}/{mode}/report/{reportName}
	PUT	/v3.0/rule/studies/{studyId}/{mode}/bulkupdate
	POST	/v3.0/studies/{studyId}/{mode}/report/{reportName}
	POST	/v4.0/studies/{studyId}/{mode}/report/{reportName}

Users, Permissions and Roles

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

• Rest API patch updates
  See the newly added endpoints of the Oracle Clinical One Platform APIs for 23.1.1, available upon the Production release.