Get list of forms in a study
get
/ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms
Retrieves all forms in a study for a specific study version.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
excludeItemType: string
Form Item type to exclude from responseAllowed Values:
[ "instructionalText" ]
-
formCategory: string
Return forms with this Form Category.Default Value:
DCS
-
items: string
-
mode(required): string
Study version mode for Data Classifications.Default Value:
design
Allowed Values:[ "test", "training", "active", "design" ]
-
showParent: string
-
taggedOnly: boolean
Returns forms with tagged itemsDefault Value:
false
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 FormDto v17.0
Title:
FormDto v17.0
Form Info
Nested Schema : FormDto v17.0
Type:
object
Title:
FormDto v17.0
Form Info
Show Source
-
allowMultipleInstances: boolean
Allow multiple instancesExample:
true
-
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
-
formCategory: string
Form categoryExample:
DCS
-
formSubcategory: array
formSubcategory
Form subcategory list
-
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
-
includeInSafetyCaseData: boolean
Is form associated to Safety Case FormsExample:
true
-
items: array
items
-
linkFrom: array
linkFrom
linked from forms
-
logoFileName: string
Logo File Name
-
logoFileUploadRequest: object
FileUploadRequest
Logo uploaded to fileupload service response name
-
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 v17.0
Title:
FormCopySourceDto v17.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 : 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 v17.0
Title:
From Item Advanced Property With Parent v17.0
Form Item Advanced Property with Parent Info
Nested Schema : formSubcategory
Type:
array
Form subcategory list
Show Source
-
Array of:
string
Form subcategory list
Nested Schema : items
Type:
Show Source
array
-
Array of:
object FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information
Nested Schema : linkFrom
Type:
array
linked from forms
Show Source
-
Array of:
object FormLinkFromDto v17.0
Title:
FormLinkFromDto v17.0
Linked From Form Details
Nested Schema : FileUploadRequest
Type:
object
Logo uploaded to fileupload service response name
Show Source
-
contentType: string
File Content-Type
-
fileName(required): string
File nameExample:
File1001
-
mode(required): string
Mode of the study, accepts: test, active, or trainingExample:
test, active, or training
-
name(required): string
Random name for bucket where file uploadedExample:
1A73BC4FE4954AE4AC50DDF9729F80BE
Nested Schema : showFrom
Type:
array
show dynamic parent from forms of same visit
Show Source
-
Array of:
object FormLinkFromDto v17.0
Title:
FormLinkFromDto v17.0
Linked From Form Details
Nested Schema : FormCopySourceDto v17.0
Type:
object
Title:
FormCopySourceDto v17.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 v17.0
Type:
object
Title:
From Item Advanced Property With Parent v17.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 v17.0
Title:
From Item Advanced Property Rule v17.0
Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v17.0
Type:
object
Title:
From Item Advanced Property Rule v17.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 v17.0
Type:
object
Title:
FormItemDto v17.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 v17.0
Title:
FormNumberItemDto v17.0
Form Number Item Details Information -
object
FormChoiceItemDto v17.0
Title:
FormChoiceItemDto v17.0
Form Choice Item Details Information -
object
FormTextItemDto v17.0
Title:
FormTextItemDto v17.0
Form text Item Details Information -
object
FormDatetimeItemDto v17.0
Title:
FormDatetimeItemDto v17.0
Form DateTime Item Details Information -
object
FormQuestionGroupItemDto v17.0
Title:
FormQuestionGroupItemDto v17.0
Form Question Group Item Details Information -
object
FormTableItemDto v17.0
Title:
FormTableItemDto v17.0
Form table Item Details Information -
object
FormSectionalItemDto v17.0
Title:
FormSectionalItemDto v17.0
Form Section Item Details Information -
object
FormLabelItemDto
-
object
FormInstructionalTextItem v17.0
Title:
FormInstructionalTextItem v17.0
Instructional information about the form or question -
object
Form existing data item DTO
Form existing data item Information
Nested Schema : advancedProps
Type:
Show Source
array
-
Array of:
object From Item Advanced Property v17.0
Title:
From Item Advanced Property v17.0
Form Item Advanced Property
Nested Schema : dataClassificationIds
Type:
Show Source
array
-
Array of:
object From Item Advanced Property v17.0
Title:
From Item Advanced Property v17.0
Form Item Advanced Property
Nested Schema : FormNumberItemDto v17.0
Type:
object
Title:
FormNumberItemDto v17.0
Form Number Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
FormNumberItemDto v17.0-allOf[1]
Nested Schema : FormChoiceItemDto v17.0
Type:
object
Title:
FormChoiceItemDto v17.0
Form Choice Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
FormChoiceItemDto v17.0-allOf[1]
Nested Schema : FormTextItemDto v17.0
Type:
object
Title:
FormTextItemDto v17.0
Form text Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
FormTextItemDto v17.0-allOf[1]
Nested Schema : FormDatetimeItemDto v17.0
Type:
object
Title:
FormDatetimeItemDto v17.0
Form DateTime Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
FormDatetimeItemDto v17.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v17.0
Type:
object
Title:
FormQuestionGroupItemDto v17.0
Form Question Group Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information
Nested Schema : FormTableItemDto v17.0
Type:
object
Title:
FormTableItemDto v17.0
Form table Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
FormTableItemDto v17.0-allOf[1]
Nested Schema : FormSectionalItemDto v17.0
Type:
object
Title:
FormSectionalItemDto v17.0
Form Section Item Details Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information
Nested Schema : FormLabelItemDto
Type:
object
Match All
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
FormLabelItemDto-allOf[1]
Nested Schema : FormInstructionalTextItem v17.0
Type:
object
Title:
FormInstructionalTextItem v17.0
Instructional information about the form or question
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
FormInstructionalTextItem v17.0-allOf[1]
Nested Schema : Form existing data item DTO
Type:
object
Form existing data item Information
Match All
Show Source
-
object
FormItemDto v17.0
Title:
FormItemDto v17.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }
Form Item Information -
object
Form existing data item DTO-allOf[1]
Nested Schema : From Item Advanced Property v17.0
Type:
object
Title:
From Item Advanced Property v17.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 v17.0
Title:
From Item Advanced Property Rule v17.0
Form Item Advanced Property Rule
Nested Schema : FormNumberItemDto v17.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 v17.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 v17.0
Title:
From Item Advanced Property With Parent v17.0
Form Item Advanced Property with Parent Info
Nested Schema : options
Type:
Show Source
array
-
Array of:
object FormOptionDto v17.0
Title:
FormOptionDto v17.0
Form choice item option details
Nested Schema : FormOptionDto v17.0
Type:
object
Title:
FormOptionDto v17.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 v17.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 v17.0-allOf[1]
Type:
Show Source
object
-
allowFutureDate: integer
(int32)
Minimum Value:
0
Maximum Value:1
Allow future dateExample:1
-
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 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 : 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 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 : 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 : 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 : FormInstructionalTextItem v17.0-allOf[1]
Type:
Show Source
object
-
instructionalText: string
Instructional information about the form or questionExample:
Complete all parts of the form
Nested Schema : Form existing data item DTO-allOf[1]
Type:
Show Source
object
-
codeName: string
Codelist name for existing data, must be a value from ExistingDataLabels codelistExample:
EDLSite
-
codeValue: string
Codelist value specifying existing data, must be a value from codelist defined in codeNameExample:
SiteName
Nested Schema : FormLinkFromDto v17.0
Type:
object
Title:
FormLinkFromDto v17.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 v17.0
Title:
From Item Advanced Property With Parent v17.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 v17.0
Title:
From Item Advanced Property With Parent v17.0
Form Item Advanced Property with Parent Info
500 Response
Error
Nested Schema : details
Type:
object