REST API for Clinical One Platform

v1.0 REST Endpoints

Designer/Study APIs/Study Actions/v1.0

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

~~[Deprecated]: Add study~~: Method: post
Path: /ec-designer-svc/rest/v1.0/studies
~~[Deprecated]: Check visit in study version~~: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visits/{visitId}/validate
~~[Deprecated]: Get a list of all studies~~: Method: get
Path: /ec-designer-svc/rest/v1.0/studies
~~[Deprecated]: Get all statuses of a study~~: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statuses
~~[Deprecated]: Get all statuses summary of a study~~: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statusessummary
~~[Deprecated]: Get coding questions in all forms~~: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms
~~[Deprecated]: Get status of latest study version~~: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statuses/{version}
~~[Deprecated]: Update existing study~~: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}
Check form in study version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/validate
Check form item existence in study.: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/items/{formItemId}/validate
Clone system codelist: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/cloneSystemCodelist
Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/studyDesign
Get a study's status: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/state
Get all form items in a form: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/formitems
Get all form items in a form by form ID: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/formitems
Get all forms: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/allForms
Get all study versions of multiple tenants: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/all
Get IDs of all artifacts in a study in a specific mode: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/objectids
Get IDs of all artifacts in an approved study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/approved/objectids
Get latest study versions of a tenant: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/tenant
Get list of treatment arms for all study versions: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/arms
Get maximum study versions of a tenant: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/maxversion/tenant
Get options of all choice items by study mode and form ID(s): Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/choiceoptions
Get options of all choice items in the latest approved version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/approved/choiceoptions
Get study identity based on protocol ID: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/identity
Get study rule copy status: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/studycopystatus
Update a study's state: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/state/{statedata}
Update study rule copy status: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/studycopystatus