REST API patch updates

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

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

Data Capture

Change Endpoint
New
  • POST /v13.0/studies/{studyId}/{mode}/dataelements
  • PUT /v2.0/studies/{studyId}/{mode}/dataelements/clear/forms
  • PUT /v2.0/studies/{studyId}/{mode}/properties/{type}/{subjectId}/{id}
  • PUT /v3.0/studies/{studyId}/{mode}/ehrdata
  • POST /v4.0/studies/{studyId}/{mode}/labnormals
  • PUT /v5.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
  • POST /v5.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
  • DELETE /v5.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements

Data Hub

Change Endpoint
New
  • POST /v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
  • POST /v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
  • POST /v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
  • POST /v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
  • POST /v14.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
  • POST /v15.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
  • POST /v16.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/sites
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms/actions
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/items/actions
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/safetyCases
  • POST /v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/visits/actions
  • POST /v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
  • POST /v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Deprecated
  • POST /v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
  • POST /v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
  • POST /v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
  • POST /v14.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
  • POST /v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
  • POST /v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
  • POST /v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
  • POST /v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits

Data Integration

Change Endpoint
New
  • POST /v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/dataelements/withvendorcode

Randomization and Supplies

Change Endpoint
New
  • POST /v2.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits
  • POST /v5.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • PUT /v5.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • GET /v6.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • GET /v6.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{lotId}
Deprecated
  • POST /v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • PUT /v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
  • GET /v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots
  • GET /v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}

Sites and Depots

Change Endpoint
New
  • GET /v3.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}