REST API for Clinical One Platform

v2.0 REST Endpoints

Designer/Study APIs/Study Actions/v2.0

The operations from the Designer/Study APIs/Study Actions/v2.0 category.

~~[Deprecated]: Check visit in study version~~: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visits/{visitId}/validate
~~[Deprecated]: Get all statuses of a study~~: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statuses
~~[Deprecated]: Get status of latest study version~~: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statuses/{version}
Add study: Method: post
Path: /ec-designer-svc/rest/v2.0/studies
Copy study design objects: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{targetId}/copystudyobjects
Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/studyDesign
Create study copy template: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{sourceStudyId}/copy
Get a list of all studies: Method: get
Path: /ec-designer-svc/rest/v2.0/studies
Get all coding questions forms: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/allForms/coding
Get all form items in a form: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/formitems
Get all form items in a form by form ID: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/{formId}/formitems
Get all forms: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/allForms
Get all statuses summary of a study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statusessummary
Get IDs of all artifacts in a study in a specific mode: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/objectids
Get IDs of all artifacts in an approved study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/approved/objectids
Get options of all choice items by study mode and form ID(s): Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/{formId}/choiceoptions
Get options of all choice items in the latest approved version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/approved/choiceoptions
Get summary of library studies usage: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/library/{libraryId}/studyType/{studyType}/studyUses
Retry to copy a study copy template: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{targetStudyId}/retryCopyStudy
Update existing study: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}
Update study copy status: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/updateCopyStudyStatus