REST APIの更新

Clinical One Cloud Service 26.3で、新しく追加、非推奨および削除されたエンドポイントを参照してください。

注意:

必要なすべての情報に簡単にアクセスできるように、REST APIガイドの再構築に取り組んでいます。その結果、このガイドの「タスク」の項にリストされている一部のカテゴリは、階層が若干異なるため、すべてのカテゴリが最終的に準拠するようになりました。例:
起点:
  • 「タスク」>「データ・キャプチャ」>「データ要素」> v4.0 >「試験IDおよびモードによるデータ要素スコープのクリア」
至:
  • 「タスク」>「データ・キャプチャ」>「データ要素」>「試験IDおよびモードによるデータ要素スコープのクリア」> V4.0

このドキュメントの更新は、将来のリリースで完了する予定です。

権限

このリリースでは、新しいサービスまたは権限は追加されていません。既存のサービスのみが更新されました。

データ処理

変更する エンドポイント
新規
  • POST /v1.0/studies/{studyId}/{mode}/freeze
  • プット /v1.0/studies/{studyId}/{mode}/unfreeze
  • GET /v2.0/studies/{studyId}/{mode}/signconfiguration
  • PUT /v2.0/studies/{studyId}/{mode}/signconfiguration/{signConfigurationId}
非推奨
  • プット /v1.0/studies/{studyId}/{mode}/unfreeze/vsd
  • PUT /v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

データ・キャプチャ

変更。 エンドポイント
新規
  • 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
  • プット /v2.0/studies/{studyId}/{mode}/ehrdata
  • GET /v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/nextVisitAction

データ・ハブ

変更 エンドポイント
新規
  • 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
非推奨
  • 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

データ統合

変更。 エンドポイント
新規
  • 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}

デザイナ

変更 エンドポイント
非推奨
  • 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
  • プット /v1.0/studies/{studyId}/lock
  • /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
  • プット /v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
  • /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}

デザイナーORS

注意:

Designer ORSエンドポイントは、Designerカテゴリにリストされます。
変更。 エンドポイント
新規
  • 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エンドポイントは、Designerカテゴリにリストされます。
変更 エンドポイント
新規
  • 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}
  • 削除/v11.0/studies/{studyId}/versions/{version}/visits/{visitid}

ランダム化と供給

変更する エンドポイント
新規
  • 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
  • プット /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
非推奨
  • 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

問合せ

変更。 エンドポイント
新規
  • GET /v1.0/studies/{studyId}/{mode}/queryDetails/dateRange

施設およびデポ

変更 エンドポイント
削除済
  • GET /v1/studies/{studyId}/{mode}/sdfs/clearsitecache
  • /v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmailの削除
非推奨
  • POST /v1.0/studies/{studyId}/{mode}/labs
  • /v1.0/studies/{studyId}/{mode}/siteslabsの削除