Get all visits, forms and questionnaires
get
/ec-designer-svc/rest/v8.0/studies/{studyId}/studyDesign
Retrieves all the visits, forms and questionnaires in a study ID in one or more study versions and by mode.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
-
dynamicData: boolean
Return details when call made by service to serviceDefault Value:
true
-
itemType: string
Default Value:
all
-
items: string
-
mode: string
Study version mode to filter the return dataDefault Value:
test
Allowed Values:[ "test", "active" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object StudyDesignDto v9.0
Title:
StudyDesignDto v9.0
Information about whole study design for subject .
Nested Schema : StudyDesignDto v9.0
Type:
object
Title:
StudyDesignDto v9.0
Information about whole study design for subject .
Show Source
-
forms: object
FormDto v16.0
Title:
FormDto v16.0
Form Info -
formSummary: object
FormSummaryDto v1.0
Title:
FormSummaryDto v1.0
Reduced form properties -
studyVersionVisit: object
StudyVersionVisitDtoV9
-
visits: object
StudyVisitScheduleWithFormIdsDto v8.0
Title:
StudyVisitScheduleWithFormIdsDto v8.0
Information about visit schedule and visit forms id .
Nested Schema : FormDto v16.0
Type:
object
Title:
FormDto v16.0
Form Info
Show Source
-
assignedVisits: array
assignedVisits
branch cycle information describing the visits on which the forms are displayed
-
dynamic: integer
(int32)
Count of forms items that point to this form for Show Form featureExample:
4
-
formType: string
Allowed Values:
[ "STANDARD_FORM", "LAB_FORM", "TWO_SECTION_FORM", "DRUG_RECONCILIATION_FORM", "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM" ]
Form typeExample:STANDARD_FORM
-
hasRevision: boolean
Indicate whether any revisions from a newer study version have been appliedExample:
true
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
linkFrom: array
linkFrom
linked from forms
-
refname(required): string
Minimum Length:
1
Maximum Length:64
Form refnameExample:FORM_01
-
repeat: boolean
Form repeating?Example:
false
-
showFrom: array
showFrom
show dynamic parent from forms of same visit
-
source: object
FormCopySourceDto v16.0
Title:
FormCopySourceDto v16.0
Form Copy Source Information -
title(required): string
Minimum Length:
1
Maximum Length:64
Form titleExample:Demography
-
versionStart: string
(date-time)
The form's version date
Nested Schema : FormSummaryDto v1.0
Type:
object
Title:
FormSummaryDto v1.0
Reduced form properties
Show Source
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname: string
Form refnameExample:
FORM_01
-
title: string
Form titleExample:
Demography
Nested Schema : StudyVersionVisitDtoV9
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
Nested Schema : StudyVisitScheduleWithFormIdsDto v8.0
Type:
object
Title:
StudyVisitScheduleWithFormIdsDto v8.0
Information about visit schedule and visit forms id .
Show Source
-
branchIsCycle: boolean
The branch is cyclic or acyclicExample:
true
-
branchShortName: string
Visit Branch shortNameExample:
Br1
-
branchTitle: string
Branch titleExample:
Branch1
-
cycleCount: number
number of times a branch can cycleExample:
10
-
eventType: string
Visit event typeExample:
ScreeningVisit
-
formIds: array
formIds
List of visit forms IDs
-
fullName: string
Concatenation of Visit Title and Branch title with hypenExample:
B1C01 - V01
-
id: string
(uuid)
Branch GUID
-
shortName: string
Visit shortnameExample:
W2
-
startCycle: integer
(int32)
Start Cycle Number
-
title: string
Visit titleExample:
Week2
-
visitSchedule: object
StudyVisitScheduleDto v9.0
Title:
StudyVisitScheduleDto v9.0
Study visit schedule details.
Nested Schema : assignedVisits
Type:
array
branch cycle information describing the visits on which the forms are displayed
Show Source
-
Array of:
object From Item Advanced Property With Parent v16.0
Title:
From Item Advanced Property With Parent v16.0
Form Item Advanced Property with Parent Info
Nested Schema : items
Type:
Show Source
array
-
Array of:
object FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information
Nested Schema : linkFrom
Type:
array
linked from forms
Show Source
-
Array of:
object FormLinkFromDto v16.0
Title:
FormLinkFromDto v16.0
Linked From Form Details
Nested Schema : showFrom
Type:
array
show dynamic parent from forms of same visit
Show Source
-
Array of:
object FormLinkFromDto v16.0
Title:
FormLinkFromDto v16.0
Linked From Form Details
Nested Schema : FormCopySourceDto v16.0
Type:
object
Title:
FormCopySourceDto v16.0
Form 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 : From Item Advanced Property With Parent v16.0
Type:
object
Title:
From Item Advanced Property With Parent v16.0
Form Item Advanced Property with Parent Info
Show Source
-
id: string
(uuid)
Extended Property ID
-
label: string
(uuid)
parent object ID
-
name: string
Minimum Length:
1
Maximum Length:255
Advanced property nameExample:RolloverQuestionStudyId
-
parentObjectLabel: string
parent object nameExample:
Form 1
-
parentObjectLevel: string
type of parent objectExample:
FORM
-
rules: array
rules
-
value: string
Minimum Length:
1
Maximum Length:2048
Advanced property value. For example, rollover study UUIDExample:B1B8327AFAA6412287106192AB5984EF
Nested Schema : rules
Type:
Show Source
array
-
Array of:
object From Item Advanced Property Rule v16.0
Title:
From Item Advanced Property Rule v16.0
Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v16.0
Type:
object
Title:
From Item Advanced Property Rule v16.0
Form 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 : FormItemDto v16.0
Type:
object
Title:
FormItemDto v16.0
Discriminator: questionType
Discriminator Values
Form Item Information
Show Source
-
advancedProps: array
advancedProps
-
applyChangeToVersion: string
For IPR apply change to versionExample:
1.0.0.1
-
clLabNormalsTag: string
Code list Lab Normals Tag used in the code list dialog taggingExample:
LabTest, LabUnit, LabGender, LabRace, LabStandardResult
-
dataClassificationIds: array
dataClassificationIds
-
dataClassificationLevel: string
Data classification level if applicableExample:
edit, view
-
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
-
labNormalsTag: string
Lab Normals Tag used in dialog taggingExample:
LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult
-
questionHint: string
Minimum Length:
0
Maximum Length:4000
Form question hintExample:What is your age?
-
questionLabel(required): string
Minimum Length:
1
Maximum Length:4000
Form question labelExample:Age
-
questionType(required): string
Title:
FormItemType
Allowed Values:[ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData" ]
Question typeExample:numeric
-
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:
1
Maximum Length:64
Form 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): string
Allowed Values:
[ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]
Source Data Verification TypeExample:NEVER(0),ALWAYS(1),CRITICAL(2)
-
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 v16.0
Title:
FormNumberItemDto v16.0
Form Number Item Details Information -
object
FormChoiceItemDto v16.0
Title:
FormChoiceItemDto v16.0
Form Choice Item Details Information -
object
FormTextItemDto v16.0
Title:
FormTextItemDto v16.0
Form text Item Details Information -
object
FormDatetimeItemDto v16.0
Title:
FormDatetimeItemDto v16.0
Form DateTime Item Details Information -
object
FormQuestionGroupItemDto v16.0
Title:
FormQuestionGroupItemDto v16.0
Form Question Group Item Details Information -
object
FormTableItemDto v16.0
Title:
FormTableItemDto v16.0
Form table Item Details Information -
object
FormLabelItemDto
Nested Schema : advancedProps
Type:
Show Source
array
-
Array of:
object From Item Advanced Property v16.0
Title:
From Item Advanced Property v16.0
Form Item Advanced Property
Nested Schema : dataClassificationIds
Type:
Show Source
array
-
Array of:
object From Item Advanced Property v16.0
Title:
From Item Advanced Property v16.0
Form Item Advanced Property
Nested Schema : FormNumberItemDto v16.0
Type:
object
Title:
FormNumberItemDto v16.0
Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
-
object
FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information -
object
FormNumberItemDto v16.0-allOf[1]
Nested Schema : FormChoiceItemDto v16.0
Type:
object
Title:
FormChoiceItemDto v16.0
Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
-
object
FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information -
object
FormChoiceItemDto v16.0-allOf[1]
Nested Schema : FormTextItemDto v16.0
Type:
object
Title:
FormTextItemDto v16.0
Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
-
object
FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information -
object
FormTextItemDto v16.0-allOf[1]
Nested Schema : FormDatetimeItemDto v16.0
Type:
object
Title:
FormDatetimeItemDto v16.0
Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
-
object
FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information -
object
FormDatetimeItemDto v16.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v16.0
Type:
object
Title:
FormQuestionGroupItemDto v16.0
Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
Show Source
-
object
FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information
Nested Schema : FormTableItemDto v16.0
Type:
object
Title:
FormTableItemDto v16.0
Form table Item Details Information
Match All
Form table Item Details Information
Form table Item Details Information
Show Source
-
object
FormItemDto v16.0
Title:
FormItemDto v16.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
Form Item Information -
object
FormTableItemDto v16.0-allOf[1]
Nested Schema : FormLabelItemDto
Type:
object
Match All
Show Source
-
object
FormItemDto v18.0
Title:
FormItemDto v18.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov18", "numeric":"#/components/schemas/FormNumberItemDtov18", "measurement":"#/components/schemas/FormNumberItemDtov18", "text":"#/components/schemas/FormTextItemDtov18", "choice":"#/components/schemas/FormChoiceItemDtov18", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov18", "table":"#/components/schemas/FormTableItemDtov18", "section":"#/components/schemas/FormSectionalItemDtov18", "label":"#/components/schemas/FormInstructionalTextItemDtov18", "existingData":"#/components/schemas/FormExistingDataItemDtoV18" } }
Form Item Information -
object
FormLabelItemDto-allOf[1]
Nested Schema : From Item Advanced Property v16.0
Type:
object
Title:
From Item Advanced Property v16.0
Form Item Advanced Property
Show Source
-
id: string
(uuid)
Extended Property ID
-
label: string
Rollover study nameExample:
Rollover Study BT-31
-
name: string
Minimum Length:
1
Maximum Length:255
Advanced property nameExample:RolloverQuestionStudyId
-
rules: array
rules
-
value: string
Minimum Length:
1
Maximum Length:2048
Advanced property value. For example, rollover study UUIDExample:B1B8327AFAA6412287106192AB5984EF
Nested Schema : rules
Type:
Show Source
array
-
Array of:
object From Item Advanced Property Rule v16.0
Title:
From Item Advanced Property Rule v16.0
Form Item Advanced Property Rule
Nested Schema : FormNumberItemDto v16.0-allOf[1]
Type:
Show Source
object
-
precision: integer
(int32)
Minimum Value:
0
Number value precisionExample:1
-
units: string
Units of measureExample:
kg
Nested Schema : FormChoiceItemDto v16.0-allOf[1]
Type:
Show Source
object
-
advancedProps: array
advancedProps
-
clDescription: string
Minimum Length:
0
Maximum Length:4000
Codelist 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|radioset|label
Form choice item display in UI - Selectbox.Example:selectbox
-
isCodeListReplaced: boolean
Indicates if the choice option codelist is replacedExample:
true
-
options: array
options
Nested Schema : advancedProps
Type:
Show Source
array
-
Array of:
object From Item Advanced Property With Parent v16.0
Title:
From Item Advanced Property With Parent v16.0
Form Item Advanced Property with Parent Info
Nested Schema : options
Type:
Show Source
array
-
Array of:
object FormOptionDto v16.0
Title:
FormOptionDto v16.0
Form choice item option details
Nested Schema : FormOptionDto v16.0
Type:
object
Title:
FormOptionDto v16.0
Form choice item option details
Show Source
-
clCode: string
Codelist code for a one specific choice.Example:
1
-
clDescription: string
Minimum Length:
1
Maximum Length:4000
Codelist description for a one specific choice.Example:1
-
clValue: string
Codelist value for a one specific choice.Example:
1
-
label: string
Minimum Length:
1
Maximum Length:4000
Form choice selectbox label for a one specific choice.Example:Female
-
value: string
Minimum Length:
1
Maximum Length:4000
Form choice selectbox value for a one specific choice.Example:1
Nested Schema : FormTextItemDto v16.0-allOf[1]
Type:
Show Source
object
-
maxlength: integer
(int32)
Minimum Value:
0
Maximum Value:4000
Form text item max lengthExample:4000
-
multiline: boolean
Is form text item multilineExample:
false
Nested Schema : FormDatetimeItemDto v16.0-allOf[1]
Type:
Show Source
object
-
allowPartialDate: integer
(int32)
Minimum Value:
0
Maximum Value:1
Allow partial dateExample:1
-
format: string
Date time formatExample:
DD-MON-YYYY
-
partialDate: string
Partial date formatExample:
Jan-1993
Nested Schema : FormItemDto v18.0
Type:
object
Title:
FormItemDto v18.0
Discriminator: questionType
Discriminator Values
Form Item Information
Show Source
-
advancedProps: array
advancedProps
-
applyChangeToVersion: string
For IPR apply change to versionExample:
1.0.0.1
-
clLabNormalsTag: string
Code list Lab Normals Tag used in the code list dialog taggingExample:
LabTest, LabUnit, LabGender, LabRace, LabStandardResult
-
dataClassificationIds: array
dataClassificationIds
-
dataClassificationLevel: string
Data classification level if applicableExample:
edit, view
-
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
-
labNormalsTag: string
Lab Normals Tag used in dialog taggingExample:
LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult
-
questionHint: string
Minimum Length:
0
Maximum Length:4000
Form question hintExample:What is your age?
-
questionLabel(required): string
Minimum Length:
1
Maximum Length:4000
Form question labelExample:Age
-
questionType(required): string
Title:
FormItemType
Allowed Values:[ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData" ]
Question typeExample:numeric
-
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:
1
Maximum Length:64
Form 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): string
Allowed Values:
[ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]
Source Data Verification TypeExample:NEVER(0),ALWAYS(1),CRITICAL(2)
-
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 v18.0
Title:
FormNumberItemDto v18.0
Form Number Item Details Information -
object
FormChoiceItemDto v18.0
Title:
FormChoiceItemDto v18.0
Form Choice Item Details Information -
object
FormTextItemDto v18.0
Title:
FormTextItemDto v18.0
Form text Item Details Information -
object
FormDatetimeItemDto v18.0
Title:
FormDatetimeItemDto v18.0
Form DateTime Item Details Information -
object
FormQuestionGroupItemDto v18.0
Title:
FormQuestionGroupItemDto v18.0
Form Question Group Item Details Information -
object
FormTableItemDto v18.0
Title:
FormTableItemDto v18.0
Form table Item Details Information -
object
FormSectionalItemDto v18.0
Title:
FormSectionalItemDto v18.0
Form Section Item Details Information -
object
FormLabelItemDto
-
object
FormInstructionalTextItem v18.0
Title:
FormInstructionalTextItem v18.0
Instructional information about the form or question -
object
FormExistingDataItemDtoV18
Form existing data item Information
Nested Schema : FormLabelItemDto-allOf[1]
Type:
Show Source
object
-
advancedProps: array
advancedProps
-
clDescription: string
Minimum Length:
0
Maximum Length:4000
Codelist 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|radioset|label
Form choice item display in UI - Selectbox.Example:selectbox
-
isCodeListReplaced: boolean
Indicates if the choice option codelist is replacedExample:
true
-
options: array
options
Nested Schema : advancedProps
Type:
Show Source
array
-
Array of:
object From Item Advanced Property With Parent v18.0
Title:
From Item Advanced Property With Parent v18.0
Form Item Advanced Property with Parent Info
Nested Schema : options
Type:
Show Source
array
-
Array of:
object FormOptionDto v18.0
Title:
FormOptionDto v18.0
Form choice item option details
Nested Schema : From Item Advanced Property With Parent v18.0
Type:
object
Title:
From Item Advanced Property With Parent v18.0
Form Item Advanced Property with Parent Info
Show Source
-
id: string
(uuid)
Extended Property ID
-
label: string
(uuid)
parent object ID
-
name: string
Minimum Length:
1
Maximum Length:255
Advanced property nameExample:RolloverQuestionStudyId
-
parentObjectLabel: string
parent object nameExample:
Form 1
-
parentObjectLevel: string
type of parent objectExample:
FORM
-
rules: array
rules
-
value: string
Minimum Length:
1
Maximum Length:2048
Advanced property value. For example, rollover study UUIDExample:B1B8327AFAA6412287106192AB5984EF
Nested Schema : rules
Type:
Show Source
array
-
Array of:
object From Item Advanced Property Rule v18.0
Title:
From Item Advanced Property Rule v18.0
Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v18.0
Type:
object
Title:
From Item Advanced Property Rule v18.0
Form 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 : FormOptionDto v18.0
Type:
object
Title:
FormOptionDto v18.0
Form choice item option details
Show Source
-
clCode: string
Codelist code for a one specific choice.Example:
1
-
clDescription: string
Minimum Length:
1
Maximum Length:4000
Codelist description for a one specific choice.Example:1
-
clValue: string
Codelist value for a one specific choice.Example:
1
-
label: string
Minimum Length:
1
Maximum Length:4000
Form choice selectbox label for a one specific choice.Example:Female
-
value: string
Minimum Length:
1
Maximum Length:4000
Form choice selectbox value for a one specific choice.Example:1
Nested Schema : FormLinkFromDto v16.0
Type:
object
Title:
FormLinkFromDto v16.0
Linked From Form Details
Show Source
-
formId: string
(uuid)
Form GUID
-
items: array
items
Form items
-
parentAssignedVisits: array
parentAssignedVisits
Parent Assigned Visits
Nested Schema : items
Type:
array
Form items
Show Source
-
Array of:
object From Item Advanced Property With Parent v16.0
Title:
From Item Advanced Property With Parent v16.0
Form Item Advanced Property with Parent Info
Nested Schema : parentAssignedVisits
Type:
array
Parent Assigned Visits
Show Source
-
Array of:
object From Item Advanced Property With Parent v16.0
Title:
From Item Advanced Property With Parent v16.0
Form Item Advanced Property with Parent Info
Nested Schema : items
Type:
Show Source
array
-
Array of:
object FormItemSummaryDto v1.0
Title:
FormItemSummaryDto v1.0
Reduced form item properties
Nested Schema : FormItemSummaryDto v1.0
Type:
object
Title:
FormItemSummaryDto v1.0
Reduced form item properties
Show Source
-
id: string
(uuid)
Form Item Unique GUID
-
questionLabel: string
Form question labelExample:
Age
-
questionType: string
Title:
FormItemType
Allowed Values:[ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData" ]
Question typeExample:numeric
-
refname: string
Form item reference name.Example:
NUMBER_01
-
subItemIds: string
(uuid)
Title:
Sub item ids
List of sub question ids
Nested Schema : formIds
Type:
array
List of visit forms IDs
Show Source
-
Array of:
string(uuid)
List of visit forms IDs
Example:
[
"938D23FA6B7241CCA41BD627E5DB60DA",
"699EF3745FC545589F186D2198F3C65E"
]
Nested Schema : StudyVisitScheduleDto v9.0
Type:
object
Title:
StudyVisitScheduleDto v9.0
Study visit schedule details.
Show Source
-
branchId: string
(uuid)
Branch Id
-
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
-
outOfWindowAlert: string
(string)
Outside Visit Window AlertExample:
OFF
-
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