Create all visits, forms and questionnaires
post
/ec-designer-svc/rest/v3.0/studies/{studyId}/studyDesign
Creates all the visits, forms and questionnaires for the study ID on one or more study versions.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
Supported Media Types
- */*
Nested Schema : schema
Type:
Show Source
object-
studyId: string
(uuid)
-
studyTitle: string
Study nameExample:
Study 03 -
version: string
versionExample:
1.3.0.6 -
versionPreviousStatus: string
Allowed Values:
[ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]Previous study statusExample:TESTING -
versionStatus: string
Study version statusExample:
Active, not recruiting -
visitId: string
(uuid)
Visit GUID
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object StudyDesignDto v1.0
Title:
StudyDesignDto v1.0Information about whole study design for subject .
Nested Schema : StudyDesignDto v1.0
Type:
objectTitle:
StudyDesignDto v1.0Information about whole study design for subject .
Show Source
-
forms: object
FormDto v10.0
Title:
FormDto v10.0Form Info -
studyVersionVisitV1: object
StudyVersionVisitDto v1.0
Title:
StudyVersionVisitDto v1.0Information about a visit in a study version. -
visitsWithFormIds: object
StudyVisitScheduleWithFormIdsDto v1.0
Title:
StudyVisitScheduleWithFormIdsDto v1.0Information about visit schedule and visit forms id .
Nested Schema : FormDto v10.0
Type:
objectTitle:
FormDto v10.0Form Info
Show Source
-
dynamic: integer
(int32)
Count of forms items that point to this form for Show Form featureExample:
4 -
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname(required): string
Minimum Length:
1Maximum Length:64Form refnameExample:FORM_01 -
repeat: boolean
Form repeating?Example:
false -
source: object
FormCopySourceDto v10.0
Title:
FormCopySourceDto v10.0Form Copy Source Information -
title(required): string
Minimum Length:
1Maximum Length:64Form titleExample:Demography -
versionStart: string
(date-time)
The form's version date
Nested Schema : StudyVersionVisitDto v1.0
Type:
objectTitle:
StudyVersionVisitDto v1.0Information about a visit in a study version.
Show Source
Nested Schema : StudyVisitScheduleWithFormIdsDto v1.0
Type:
objectTitle:
StudyVisitScheduleWithFormIdsDto v1.0Information about visit schedule and visit forms id .
Show Source
-
formIds: array
formIds
list of Visit forms IDs
-
visits: object
StudyVisitScheduleDto v5.0
Title:
StudyVisitScheduleDto v5.0Study visit schedule details.
Nested Schema : items
Type:
Show Source
array-
Array of:
object FormItemDto v10.0
Title:
FormItemDto v10.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }Form Item Information
Nested Schema : FormCopySourceDto v10.0
Type:
objectTitle:
FormCopySourceDto v10.0Form Copy Source Information
Show Source
-
FormId: string
(uuid)
Source Form GUID
-
id: string
(uuid)
Source Study GUID
-
StudyTitle: string
Source Study titleExample:
Study-s1 -
versionstart: boolean
is Rules CopiedExample:
false
Nested Schema : FormItemDto v10.0
Type:
objectTitle:
FormItemDto v10.0Discriminator: questionType
Discriminator Values
Form Item Information
Show Source
-
advancedProps: array
advancedProps
-
dynamic: integer
(int32)
How many leading questions in this form have to be answered by user correctly before Item is included into the form.Example:
1 -
formId: string
(uuid)
Form Unique GUID
-
formTitle: string
Form titleExample:
Demography -
formula: string
Smart item formula.Example:
[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}] -
groupSequence: integer
(int32)
Group sequence.
- hidden: boolean
-
id: string
(uuid)
Form Item Unique GUID
-
isCohortFactor: boolean
Flag that indicates whether this form item is used as a factor for randomization cohort or not.Example:
false -
isStrataFactor: boolean
Flag that indicates whether this form item is used as a factor for randomization stratum or not.Example:
false -
questionHint: string
Minimum Length:
0Maximum Length:4000Form question hintExample:What is your age? -
questionLabel(required): string
Minimum Length:
1Maximum Length:4000Form question labelExample:Age -
questionType(required): string
-
randomizationTag: boolean
Flag that indicates whether this form item should be used for randomization stratification or not.Example:
true -
readOnly: boolean
Is form item read only?Example:
false -
refname(required): string
Minimum Length:
1Maximum Length:64Form item reference name.Example:NUMBER_01 -
required(required): boolean
Whether this form item is requiered or not.Example:
true -
ruleSet: string
A JSON-formatted set of rules to do validation of the answers.Example:
{'logicalOperator':'NONE','rules':[],'numberIndex':1} -
sasLabel: string
Form Item sasLabelExample:
Adverse Event -
sasVariable: string
Form Item SASVariableExample:
AE -
sdvRequired(required): boolean
Source-Documented Verification: Whether proof of the answer required?Example:
false -
sequence: integer
(int32)
Item position in the form.Example:
1 -
smartItemId: string
(uuid)
Smart item Unique GUID
-
smartObject: string
Smart object.Example:
AGE
Match One Schema
Show Source
-
object
FormNumberItemDto v10.0
Title:
FormNumberItemDto v10.0Form Number Item Details Information -
object
FormChoiceItemDto v10.0
Title:
FormChoiceItemDto v10.0Form Choice Item Details Information -
object
FormTextItemDto v10.0
Title:
FormTextItemDto v10.0Form text Item Details Information -
object
FormDatetimeItemDto v10.0
Title:
FormDatetimeItemDto v10.0Form DateTime Item Details Information -
object
FormQuestionGroupItemDto v10.0
Title:
FormQuestionGroupItemDto v10.0Form Question Group Item Details Information
Nested Schema : advancedProps
Type:
Show Source
array-
Array of:
object From Item Advanced Property v10.0
Title:
From Item Advanced Property v10.0Form Item Advanced Property
Nested Schema : FormNumberItemDto v10.0
Type:
objectTitle:
FormNumberItemDto v10.0Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
-
object
FormItemDto v10.0
Title:
FormItemDto v10.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }Form Item Information -
object
FormNumberItemDto v10.0-allOf[1]
Nested Schema : FormChoiceItemDto v10.0
Type:
objectTitle:
FormChoiceItemDto v10.0Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
-
object
FormItemDto v10.0
Title:
FormItemDto v10.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }Form Item Information -
object
FormChoiceItemDto v10.0-allOf[1]
Nested Schema : FormTextItemDto v10.0
Type:
objectTitle:
FormTextItemDto v10.0Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
-
object
FormItemDto v10.0
Title:
FormItemDto v10.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }Form Item Information -
object
FormTextItemDto v10.0-allOf[1]
Nested Schema : FormDatetimeItemDto v10.0
Type:
objectTitle:
FormDatetimeItemDto v10.0Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
-
object
FormItemDto v10.0
Title:
FormItemDto v10.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }Form Item Information -
object
FormDatetimeItemDto v10.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v10.0
Type:
objectTitle:
FormQuestionGroupItemDto v10.0Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
Show Source
-
object
FormItemDto v10.0
Title:
FormItemDto v10.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }Form Item Information
Nested Schema : From Item Advanced Property v10.0
Type:
objectTitle:
From Item Advanced Property v10.0Form Item Advanced Property
Show Source
-
id: string
(uuid)
Extended Property ID
-
label: string
Rollover study nameExample:
Rollover Study BT-31 -
name(required): string
Minimum Length:
1Maximum Length:255Advanced property nameExample:RolloverQuestionStudyId -
rules: array
rules
-
value(required): string
Minimum Length:
1Maximum Length:2048Advanced property value. For example, rollover study UUIDExample:B1B8327AFAA6412287106192AB5984EF
Nested Schema : rules
Type:
Show Source
array-
Array of:
object From Item Advanced Property Rule v10.0
Title:
From Item Advanced Property Rule v10.0Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v10.0
Type:
objectTitle:
From Item Advanced Property Rule v10.0Form Item Advanced Property Rule
Show Source
-
label: string
For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUEExample:
Yes -
name: string
nameExample:
RolloverQuestionAnswer -
value: string
For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_IDExample:
B1B8327AFAA6412287106192AB5984EF
Nested Schema : FormNumberItemDto v10.0-allOf[1]
Type:
Show Source
object-
precision: integer
(int32)
Minimum Value:
0Number value precisionExample:1 -
units: string
Units of measureExample:
kg
Nested Schema : FormChoiceItemDto v10.0-allOf[1]
Type:
Show Source
object-
clDescription: string
Minimum Length:
0Maximum Length:4000Codelist description only for choice type formitemExample:Standard gender codelist -
clTitle: string
Codelist title only for choice type formitemExample:
Gender -
columnLayout: string
Coumn Layout codelist IDExample:
EBCF17C5F8D4460AA4A9673485C79CF0 -
columnLayoutLabel: string
Coumn Layout Label in UIExample:
Single -
display: string
Pattern:
selectbox|checkbox|radiosetForm choice item display in UI - Selectbox.Example:selectbox -
options: array
options
Nested Schema : options
Type:
Show Source
array-
Array of:
object FormOptionDto v10.0
Title:
FormOptionDto v10.0Form choice item option details
Nested Schema : FormOptionDto v10.0
Type:
objectTitle:
FormOptionDto v10.0Form choice item option details
Show Source
-
clCode: string
Codelist code for a one specific choice.Example:
1 -
clDescription: string
Minimum Length:
1Maximum Length:4000Codelist description for a one specific choice.Example:1 -
label: string
Minimum Length:
1Maximum Length:4000Form choice selectbox label for a one specific choice.Example:Female -
value: string
Minimum Length:
1Maximum Length:4000Form choice selectbox value for a one specific choice.Example:1
Nested Schema : FormTextItemDto v10.0-allOf[1]
Type:
Show Source
object-
maxlength: integer
(int32)
Minimum Value:
0Maximum Value:4000Form text item max lengthExample:4000 -
multiline: boolean
Is form text item multilineExample:
false
Nested Schema : FormDatetimeItemDto v10.0-allOf[1]
Type:
Show Source
object-
allowPartialDate: integer
(int32)
Minimum Value:
0Maximum Value:1Allow partial dateExample:1 -
format: string
Pattern:
yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mmDate time formatExample:DD-MON-YYYY -
partialDate: string
Pattern:
yyyy|MMM-yyyyPartial date formatExample:Jan-1993
Nested Schema : formIds
Type:
arraylist of Visit forms IDs
Show Source
-
Array of:
string(uuid)
list of Visit forms IDs
Example:
[
"938D23FA6B7241CCA41BD627E5DB60DA",
"699EF3745FC545589F186D2198F3C65E"
]Nested Schema : StudyVisitScheduleDto v5.0
Type:
objectTitle:
StudyVisitScheduleDto v5.0Study visit schedule details.
Show Source
-
dynamic: boolean
Yes - if visit dynamic.Example:
false -
endVisitId: string
(uuid)
End visit ID
-
eventType: string
Event randomization typeExample:
Blinded -
formCount: integer
(int32)
Visit forms countExample:
1 -
fromVisitId: string
(uuid)
Scheduled from visit GUID
-
fromVisitTitle: string
Scheduled from visit titleExample:
Week1 -
id: string
(uuid)
Visit schedule GUID
-
kitCount: integer
(int32)
Visit kits countExample:
1 -
lastRequired: boolean
Yes - if visit last required.Example:
false -
randomizationId: string
(uuid)
Randomization GUID
-
refName: string
Country nameExample:
WEEK2 -
repeating: boolean
Yes - if visit repeating.Example:
false -
required: integer
(int32)
Visit scheduling delay window after (hours).Example:
1 -
screening: integer
(int32)
1 - visit is screeningExample:
1 -
sequenced: integer
(int32)
-
shortName: string
Event short nameExample:
Week2 -
startVisitId: string
(uuid)
Start visit ID
-
studyId: string
(uuid)
Study GUID
-
studyVersionStart: string
(date-time)
Study version start
-
title: string
Visit titleExample:
Week2 -
type: string
Visit typeExample:
ONSITE -
versionEnd: string
(date-time)
Version end
-
versionStart: string
(date-time)
Version start
-
visitScheduleId: string
(uuid)
Visit schedule GUID
500 Response
Error
Nested Schema : details
Type:
object