REST API updates

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

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
  • POST /v1.0/studies/{studyId}/{mode}/freeze
  • PUT /v1.0/studies/{studyId}/{mode}/unfreeze
  • GET /v2.0/studies/{studyId}/{mode}/signconfiguration
  • PUT /v2.0/studies/{studyId}/{mode}/signconfiguration/{signConfigurationId}
Deprecated
  • PUT /v1.0/studies/{studyId}/{mode}/unfreeze/vsd
  • PUT /v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

Data Capture

Change Endpoint
New
  • POST /v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/subjects/{subjectId}/events/{eventId}/dynamic-items/visibility
  • POST /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/dispensation-rollback
  • GET /v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/randomizeordispense/previous-visit-validation
  • POST /v12.0/studies/{studyId}/{mode}/subjects/visitschedule
  • PUT /v2.0/studies/{studyId}/{mode}/ehrdata
  • GET /v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/nextVisitAction

Data Hub

Change Endpoint
New
  • POST /v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/safetyCases
  • POST /v10.0/tenant/{tenantId}/studies/{studyId}/dataCollection
  • GET /v11.0/studies/{studyId}/{mode}/odm/metadata
  • POST /v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
  • POST /v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
  • POST /v14.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
  • POST /v15.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v4.0/tenant/{tenantId}/studies/{studyId}/codelists
  • POST /v8.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
Deprecated
  • POST /v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
  • POST /v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
  • POST /v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
  • POST /v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/codelists
  • POST /v6.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations

Data Integration

Change Endpoint
New
  • GET /v1.0/studies/{studyId}/{mode}/dataelements/all/dateRange
  • GET /v1.0/studies/{studyId}/{mode}/form/verify/status/dateRange
  • GET /v1.0/studies/{studyId}/{mode}/formstatus/subjects/dateRange
  • GET /v1.0/studies/{studyId}/{mode}/subjects/history/all/dateRange
  • GET /v1.0/studies/{studyId}/{mode}/visitstatus/subjects/dateRange
  • GET /v2.0/studies/{studyId}/{mode}/codingstatus
  • GET /v2.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}

Designer

Change Endpoint
Deprecated
  • GET /v1.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
  • GET /v1.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
  • POST /v1.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
  • POST /v1.0/studies/{studyId}/lock
  • PUT /v1.0/studies/{studyId}/lock
  • DELETE /v1.0/studies/{studyId}/lock
  • GET /v1.0/studies/{studyId}/versions/{version}/design
  • DELETE /v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/{formId}
  • GET /v2.0/studies/{studyId}/versions/{version}/forms
  • GET /v2.0/studies/{studyId}/versions/{version}/forms/{formId}
  • PUT /v2.0/studies/{studyId}/versions/{version}/forms/{formId}
  • DELETE /v2.0/studies/{studyId}/versions/{version}/forms/{formId}
  • POST /v2.0/studies/{studyId}/versions/{version}/forms/visits
  • 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
  • GET /v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v4.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
  • GET /v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items
  • GET /v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
  • POST /v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items
  • PUT /v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
  • DELETE /v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
  • GET /v5.0/studies/{studyId}/versions/latest/studyversionobjects
  • GET /v6.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • POST /v7.0/studies/{studyId}/design
  • GET /v8.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
  • GET /v17.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
  • GET /v17.0/studies/{studyId}/versions/{version}/forms/unblinded
  • PUT /v17.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer ORS

Note:

Designer ORS endpoints are listed in the Designer category.
Change Endpoint
New
  • POST /v11.0/studies/{studyId}/versions/{version}/kits
  • GET /v11.0/studies/{studyId}/versions/{version}/kits
  • GET /v11.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • PUT /v11.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • DELETE /v11.0/studies/{studyId}/versions/{version}/kits/{kitId}
  • GET /v11.0/studies/{studyId}/versions/{version}/visits/{visitId}/kits/blindedInfo
  • GET /v8.0/studies/{studyId}/kits
  • GET /v8.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo

Designer Study

Note:

Designer Study endpoints are listed in the Designer category.
Change Endpoint
New
  • POST /v11.0/studies/{studyId}/design
  • GET /v11.0/studies/{studyId}/versions/{version}/design
  • POST /v11.0/studies/{studyId}/versions/{version}/visits
  • GET /v11.0/studies/{studyId}/versions/{version}/visits
  • GET /v11.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • PUT /v11.0/studies/{studyId}/versions/{version}/visits/{visitid}
  • DELETE /v11.0/studies/{studyId}/versions/{version}/visits/{visitid}

Randomization and Supplies

Change Endpoint
New
  • POST /v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers/randstatus/bulk
  • POST /v1.0/studies/{studyId}/{mode}/supply/settings/combination-dosing
  • GET /v1.0/studies/{studyId}/{mode}/supply/settings/combination-dosing
  • GET /v1.0/studies/{studyId}/{mode}/supply/settings/combination-dosing/{combination_kit_id}
  • PUT /v1.0/studies/{studyId}/{mode}/supply/settings/combination-dosing/{combination_kit_id}
  • DELETE /v1.0/studies/{studyId}/{mode}/supply/settings/combination-dosing/{combination_kit_id}
  • GET /v12.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
  • GET /v12.0/studies/{studyId}/{mode}/supply/settings
  • PUT /v12.0/studies/{studyId}/{mode}/supply/settings
  • POST /v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • PUT /v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • POST /v4.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
  • GET /v5.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • GET /v5.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • GET /v6.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
  • GET /v6.0/studies/{studyId}/{mode}/unblinded-disp-history
  • POST /v8.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Deprecated
  • 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}/lots/manufacturing-lots
  • GET /v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • GET /v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
  • GET /v4.0/studies/{studyId}/{mode}/unblinded-disp-history
  • GET /v10.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Query

Change Endpoint
New
  • GET /v1.0/studies/{studyId}/{mode}/queryDetails/dateRange

Sites and Depots

Change Endpoint
Deleted
  • GET /v1/studies/{studyId}/{mode}/sdfs/clearsitecache
  • DELETE /v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail
Deprecated
  • POST /v1.0/studies/{studyId}/{mode}/labs
  • DELETE /v1.0/studies/{studyId}/{mode}/siteslabs

Parent topic: What's new in 26.3