Rest API updates

See the newly added, deprecated, and deleted endpoints in Clinical One Cloud Service 26.2.

Note:

To ensure you can easily access all the information that you need, we are working on restructuring the REST API guide. As a result, some of the categories listed under the Tasks section of this guide now follow a slightly different hierarchy, to which all categories will eventually conform. For example:
From:
  • Tasks > Data Capture > Data Elements > v4.0 > Clear data elements scope by study ID and mode
To:
  • Tasks > Data Capture > Data Elements > Clear data elements scope by study ID and mode>V4.0

This documentation update will be completed in future releases.

Permissions

For this release, no new services or permissions have been added. Only existing services have been updated.

Service updates

The following services are updated:

Data Actions

Change Endpoint
New
  • PUT /v3.0/studies/{studyId}/{mode}/unsign-unverifyforitem

Data Capture

Change Endpoint
New
  • PUT /v1.0/studies/{studyId}/{mode}/dataelements/clear/forms
  • POST /v1.0/studies/{studyId}/{mode}/repeatinginstances/multiple/subjectId/{subjectId}
  • POST /v1.0/studies/{studyId}/{mode}/subjects/screen/validate
  • GET /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/screendates
  • GET /v11.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
  • POST /v11.0/studies/{studyId}/{mode}/subjects/visitschedule
  • PUT /v12.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
  • POST /v2.0/studies/{studyId}/{mode}/subjects/screen
  • POST /v6.0/studies/{studyId}/{mode}/visitstatus
  • PUT /v7.0/studies/{studyId}/{mode}/subjects/{subjectId}
  • GET /v8.0/studies/{studyId}/{mode}/subjects/{subjectId}

Data Hub

Change Endpoint
New
  • POST /v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/sites
  • POST /v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
  • GET /v12.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
  • GET /v12.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
  • POST /v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
  • POST /v7.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
  • POST /v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Deprecated
  • GET /v10.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
  • GET /v10.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
  • POST /v5.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
  • POST /v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
  • POST /v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits

Data Integration

Change Endpoint
New
  • GET /v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
  • GET /v5.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
  • GET /v6.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Designer

Change Endpoint
Deprecated
  • POST /v1.0/report/{reportName}
  • POST /v1.0/studies/{studyId}/allForms
  • GET /v1.0/studies/{studyId}/approved/choiceoptions
  • GET /v1.0/studies/{studyId}/approved/objectids
  • POST /v1.0/studies/{studyId}/forms/formitems
  • POST /v1.0/studies/{studyId}/forms/{formId}/choiceoptions
  • GET /v1.0/studies/{studyId}/forms/{formId}/formitems
  • GET /v1.0/studies/{studyId}/forms/{formId}/itemhistory
  • GET /v1.0/studies/{studyId}/objectids
  • GET /v1.0/studies/{studyId}/randomizationfactors
  • POST /v1.0/studies/{studyId}/studyDesign
  • GET /v1.0/studies/{studyId}/versions
  • DELETE /v1.0/studies/{studyId}/versions/{version}
  • POST /v1.0/studies/{studyId}/versions/{version}/branches
  • GET /v1.0/studies/{studyId}/versions/{version}/branches
  • GET /v1.0/studies/{studyId}/versions/{version}/branches/{branchid}
  • PUT /v1.0/studies/{studyId}/versions/{version}/branches/{branchid}
  • DELETE /v1.0/studies/{studyId}/versions/{version}/branches/{branchid}
  • GET /v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/dispense/kits/{kitId}
  • POST /v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/kits/{kitId}
  • POST /v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}
  • POST /v1.0/studies/{studyId}/versions/{version}/forms/copyForms
  • GET /v1.0/studies/{studyId}/versions/{version}/forms/numericItems
  • GET /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts
  • GET /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/arms
  • GET /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
  • PUT /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
  • POST /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
  • GET /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
  • POST /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
  • PUT /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
  • DELETE /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
  • GET /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
  • PUT /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
  • DELETE /v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
  • GET /v1.0/studies/{studyId}/versions/{version}/studyMetadata
  • GET /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • GET /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • PUT /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
  • POST /v1.0/studies/{studyId}/visitsMetadata
  • GET /v1.0/studies/{studyId}/{mode}/forms
  • POST /v1.0/studies/{studyId}/lockObjectDetails
  • GET /v10.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
  • GET /v10.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v11.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
  • GET /v11.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v12.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v13.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v14.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v15.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v16.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • POST /v2.0/report/{reportName}
  • POST /v2.0/studies
  • GET /v2.0/studies
  • PUT /v2.0/studies/{studyId}
  • POST /v2.0/studies/{studyId}/allForms
  • POST /v2.0/studies/{studyId}/allForms/coding
  • GET /v2.0/studies/{studyId}/approved/choiceoptions
  • POST /v2.0/studies/{studyId}/lockObjectDetails
  • POST /v2.0/studies/{studyId}/studyDesign
  • POST /v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}
  • POST /v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
  • GET /v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
  • PUT /v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
  • GET /v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
  • GET /v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
  • GET /v2.0/studies/{studyId}/{mode}/forms
  • POST /v3.0/studies
  • PUT /v3.0/studies/{studyId}
  • POST /v3.0/studies/{studyId}/allForms
  • POST /v3.0/studies/{studyId}/allForms/coding
  • GET /v3.0/studies/{studyId}/kits
  • GET /v3.0/studies/{studyId}/statusessummary
  • POST /v3.0/studies/{studyId}/studyDesign
  • GET /v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
  • GET /v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
  • POST /v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
  • PUT /v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
  • DELETE /v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
  • GET /v3.0/studies/{studyId}/visits/{visitId}/validate
  • POST /v3.0/studies/{studyId}/lockObjectDetails
  • POST /v4.0/studies/{studyId}/allForms
  • GET /v4.0/studies/{studyId}/statuses
  • GET /v4.0/studies/{studyId}/statuses/{version}
  • POST /v4.0/studies/{studyId}/studyDesign
  • POST /v4.0/studies/{studyId}/versions/{version}/randomizations
  • GET /v4.0/studies/{studyId}/versions/{version}/randomizations
  • GET /v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
  • PUT /v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
  • DELETE /v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
  • GET /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • GET /v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
  • POST /v5.0/studies/{studyId}/allForms
  • GET /v5.0/studies/{studyId}/statuses
  • GET /v5.0/studies/{studyId}/statuses/{version}
  • GET /v5.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
  • GET /v5.0/studies/{studyId}/versions/{version}/dispensings
  • PUT /v5.0/studies/{studyId}/versions/{version}/dispensings
  • POST /v5.0/studies/{studyId}/versions/{version}/kits
  • GET /v5.0/studies/{studyId}/versions/{version}/kits
  • GET /v5.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • PUT /v5.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • GET /v5.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
  • GET /v5.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
  • GET /v5.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v5.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v5.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • GET /v5.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
  • GET /v5.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v5.0/studies/{studyId}/versions/{version}/visitschedules
  • POST /v6.0/studies/{studyId}/design
  • GET /v6.0/studies/{studyId}/studyDesign
  • GET /v6.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
  • GET /v6.0/studies/{studyId}/versions/{version}/design
  • POST /v6.0/studies/{studyId}/versions/{version}/kits
  • GET /v6.0/studies/{studyId}/versions/{version}/kits
  • GET /v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • PUT /v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • DELETE /v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • GET /v6.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
  • GET /v6.0/studies/{studyId}/versions/{version}/visits
  • GET /v6.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v6.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v6.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • GET /v6.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
  • GET /v6.0/studies/{studyId}/versions/{version}/visitschedules
  • GET /v7.0/studies/{studyId}/statuses
  • GET /v7.0/studies/{studyId}/statuses/{version}
  • POST /v7.0/studies/{studyId}/studyDesign
  • GET /v7.0/studies/{studyId}/studyDesign
  • POST /v7.0/studies/{studyId}/studyDesign/paginated
  • GET /v7.0/studies/{studyId}/versions/{version}/design
  • 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}
  • PUT /v7.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • DELETE /v7.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • GET /v7.0/studies/{studyId}/versions/{version}/visits
  • GET /v7.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v7.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v7.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • GET /v7.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
  • GET /v7.0/studies/{studyId}/versions/{version}/visitschedules
  • POST /v8.0/studies/{studyId}/design
  • POST /v8.0/studies/{studyId}/studyDesign
  • POST /v8.0/studies/{studyId}/studyDesign/paginated
  • GET /v8.0/studies/{studyId}/versions/{version}/design
  • POST /v8.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
  • GET /v8.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
  • 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}
  • POST /v8.0/studies/{studyId}/versions/{version}/visits
  • GET /v8.0/studies/{studyId}/versions/{version}/visits
  • GET /v8.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v8.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v8.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • POST /v9.0/studies/{studyId}/design
  • POST /v9.0/studies/{studyId}/studyDesign
  • GET /v9.0/studies/{studyId}/versions/{version}/design
  • GET /v9.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
  • POST /v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
  • GET /v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
  • 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}
  • GET /v9.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer EDC

Note:

Designer EDC endpoints are listed in the Designer category.
Change Endpoint
Deprecated
  • GET /v1.0/studies/{studyId}/{mode}/forms/formitems
  • POST /v1.0/studies/{studyId}/visitsforms/formitems
  • GET /v1.0/studies/{studyId}/{mode}/forms/latest
  • POST /v18.0/studies/{studyId}/versions/{version}/forms
  • GET /v18.0/studies/{studyId}/versions/{version}/forms/unblinded
  • GET /v18.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
  • PUT /v18.0/studies/{studyId}/versions/{version}/forms/{formId}
  • DELETE /v18.0/studies/{studyId}/versions/{version}/forms/{formId}
  • POST /v19.0/studies/{studyId}/versions/{version}/forms
  • GET /v19.0/studies/{studyId}/versions/{version}/forms
  • GET /v19.0/studies/{studyId}/versions/{version}/forms/unblinded
  • GET /v19.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
  • GET /v19.0/studies/{studyId}/versions/{version}/forms/{formId}
  • PUT /v19.0/studies/{studyId}/versions/{version}/forms/{formId}
  • DELETE /v19.0/studies/{studyId}/versions/{version}/forms/{formId}
  • GET /v19.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • POST /v4.0/studies/{studyId}/lockObjectDetails

Designer ORS

Note:

Designer ORS endpoints are listed in the Designer category.
Change Endpoint
Deprecated
  • GET v6.0/studies/{studyId}/kits

Randomization and Supplies

Change Endpoint
New
  • PUT /v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/received-date
  • DELETE /v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
  • PUT /v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received-date
  • GET /v2.0/studies/{studyId}/{mode}/kittypes/noblindinggroup
  • POST /v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/replaceRand
  • POST /v2.0/studies/{studyId}/{mode}/visits/migrateDispensation
  • GET /v4.0/studies/{studyId}/{mode}/sites/{siteId}/shipments
  • GET /v5.0/studies/{studyId}/{mode}/shipments/{shipmentId}
  • GET /v9.0/studies/{studyId}/{mode}/shipments
Deprecated
  • POST /v1.0/studies/{studyId}/{mode}/reports/cohortenrollments
  • POST /v1.0/studies/{studyId}/{mode}/reports/cohortenrollments/history
  • POST /v1.0/studies/{studyId}/{mode}/reports/doseholdsettings
  • POST /v1.0/studies/{studyId}/{mode}/reports/inventorysettings
  • POST /v1.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
  • POST /v1.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
  • POST /v1.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
  • POST /v1.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
  • POST /v1.0/studies/{studyId}/{mode}/reports/order-summary
  • POST /v1.0/studies/{studyId}/{mode}/reports/projectedsupplies/countrycounts
  • POST /v1.0/studies/{studyId}/{mode}/reports/projectedsupplies/sitecounts
  • POST /v1.0/studies/{studyId}/{mode}/reports/recon
  • GET /v1.0/studies/{studyId}/{mode}/settings
  • GET /v1.0/studies/{studyId}/{mode}/sites
  • POST /v1.0/studies/{studyId}/{mode}/resupply/initial
  • POST /v1.0/studies/{studyId}/{mode}/resupply/manual
  • POST /v1.0/studies/{studyId}/{mode}/resupply/resupply
  • GET /v1.0/studies/{studyId}/{mode}/shipment-statuses
  • GET /v1.0/studies/{studyId}/{mode}/shipments
  • GET /v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}
  • GET /v1.0/studies/{studyId}/{mode}/supply/settings
  • PUT /v1.0/studies/{studyId}/{mode}/supply/settings
  • POST /v1.0/studies/{studyId}/{mode}/visits/subjectvisit
  • GET /v1.0/studies/{studyId}/{mode}/visits/subjectvisit
  • GET /v2.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
  • POST /v2.0/studies/{studyId}/{mode}/visits/subjectvisit
  • GET /v2.0/studies/{studyId}/{mode}/visits/subjectvisit
  • POST /v2.0/studies/{studyId}/{mode}/reports/dispensations
  • POST /v2.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
  • POST /v2.0/studies/{studyId}/{mode}/reports/order-summary
  • POST /v2.0/studies/{studyId}/{mode}/reports/recon
  • POST /v2.0/studies/{studyId}/{mode}/reports/subjects
  • POST /v2.0/studies/{studyId}/{mode}/reports/unblindedrandreport
  • POST /v3.0/studies/{studyId}/{mode}/reports/dispensations
  • POST /v3.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
  • POST /v3.0/studies/{studyId}/{mode}/reports/order-summary
  • POST /v3.0/studies/{studyId}/{mode}/reports/subjects
  • POST /v3.0/studies/{studyId}/{mode}/reports/unblindedrandreport
  • POST /v4.0/studies/{studyId}/{mode}/reports/dispensations
  • POST /v4.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
  • POST /v5.0/studies/{studyId}/{mode}/reports/dispensations
  • POST /v5.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
  • POST /v6.0/studies/{studyId}/{mode}/reports/dispensations

Query

Change Endpoint
New
  • PUT /v10.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
  • PUT /v10.0/studies/{studyId}/{mode}/queries/{queryId}/close
  • POST /v3.0/studies/{studyId}/{mode}/querymgmt/openQueryList
  • POST /v3.0/studies/{studyId}/{mode}/querymgmt/queryList

Users, Permissions and Roles

Change Endpoint
Deleted
  • GET /v1.0/authroles
  • GET /v1.0/authroles/{studyId}
  • GET /v1.0/authusers/{userid}/studies/{studyId}
  • PUT /v1.0/authusers/{userid}/studies/{studyId}
  • GET /v2.0/authstudies/{studyId}/users
  • GET /v2.0/authusers/{userid}/studies/{studyId}
  • GET /v2.0/globalroles/users

Parent topic: What's new in 26.2