Get list of forms in a study
get
/ec-designer-edc-svc/rest/v19.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
-
dynamicData: boolean
Return details when call made by service to serviceDefault Value:
true -
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:
designAllowed 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 v19.0
Title:
FormDto v19.0Form Info
Nested Schema : FormDto v19.0
Type:
objectTitle:
FormDto v19.0Form 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:
1Maximum Length:64Form refnameExample:FORM_01 -
repeat: boolean
Form repeating?Example:
false -
showFrom: array
showFrom
show dynamic parent from forms of same visit
-
source: object
FormCopySourceDto v19.0
Title:
FormCopySourceDto v19.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 : assignedVisits
Type:
arraybranch cycle information describing the visits on which the forms are displayed
Show Source
-
Array of:
object From Item Advanced Property With Parent v19.0
Title:
From Item Advanced Property With Parent v19.0Form Item Advanced Property with Parent Info
Nested Schema : formSubcategory
Type:
arrayForm subcategory list
Show Source
-
Array of:
string
Form subcategory list
Nested Schema : items
Type:
Show Source
array-
Array of:
object FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information
Nested Schema : linkFrom
Type:
arraylinked from forms
Show Source
-
Array of:
object FormLinkFromDto v19.0
Title:
FormLinkFromDto v19.0Linked From Form Details
Nested Schema : FileUploadRequest
Type:
objectLogo 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:
arrayshow dynamic parent from forms of same visit
Show Source
-
Array of:
object FormLinkFromDto v19.0
Title:
FormLinkFromDto v19.0Linked From Form Details
Nested Schema : FormCopySourceDto v19.0
Type:
objectTitle:
FormCopySourceDto v19.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 : From Item Advanced Property With Parent v19.0
Type:
objectTitle:
From Item Advanced Property With Parent v19.0Form Item Advanced Property with Parent Info
Show Source
-
id: string
(uuid)
Extended Property ID
-
label: string
(uuid)
parent object ID
-
name: string
Minimum Length:
1Maximum Length:255Advanced property nameExample:RolloverQuestionStudyId -
parentObjectLabel: string
parent object nameExample:
Form 1 -
parentObjectLevel: string
type of parent objectExample:
FORM -
rules: array
rules
-
value: 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 v19.0
Title:
From Item Advanced Property Rule v19.0Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v19.0
Type:
objectTitle:
From Item Advanced Property Rule v19.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 : FormItemDto v19.0
Type:
objectTitle:
FormItemDto v19.0Discriminator: 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 -
e2br3Mapping: array
e2br3Mapping
-
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:
0Maximum Length:4000Form question hintExample:What is your age? -
questionLabel(required): string
Minimum Length:
1Maximum Length:4000Form question labelExample:Age -
questionType(required): string
Title:
FormItemTypeAllowed Values:[ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]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:
1Maximum Length:64Form item reference name.Example:NUMBER_01 -
required(required): boolean
Whether this form item is requiered or not.Example:
true -
requiredDispensation: boolean
Form items tagged as dispensation will are used as the minimum data collected on a Dispensation Event.Example:
false -
requiredForCaseCreate: boolean
Form items tagged as required for case create are mandatory as the minimum data collected on a Safety Case collection.Example:
false -
requiredRandomization: boolean
Form items tagged as randomization will are used as the minimum data collected on a Randomization Event.Example:
false -
requiredScreening: boolean
Form items tagged as screening will are used as the minimum data collected on a Screening Event.Example:
false -
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 -
triggerFollowupCase: boolean
Form items tagged as trigger followup case are having safety rules enabled for safety rules creation.Example:
false
Match One Schema
Show Source
-
object
FormNumberItemDto v19.0
Title:
FormNumberItemDto v19.0Form Number Item Details Information -
object
FormChoiceItemDto v19.0
Title:
FormChoiceItemDto v19.0Form Choice Item Details Information -
object
FormTextItemDto v19.0
Title:
FormTextItemDto v19.0Form text Item Details Information -
object
FormDatetimeItemDto v19.0
Title:
FormDatetimeItemDto v19.0Form DateTime Item Details Information -
object
FormQuestionGroupItemDto v19.0
Title:
FormQuestionGroupItemDto v19.0Form Question Group Item Details Information -
object
FormTableItemDto v19.0
Title:
FormTableItemDto v19.0Form table Item Details Information -
object
FormSectionalItemDto v19.0
Title:
FormSectionalItemDto v19.0Form Section Item Details Information -
object
FormLabelItemDto
-
object
FormInstructionalTextItem v19.0
Title:
FormInstructionalTextItem v19.0Instructional information about the form or question -
object
FormExistingDataItemDtov19
Form existing data item Information
-
object
FormFileUploadItemDto
Nested Schema : advancedProps
Type:
Show Source
array-
Array of:
object From Item Advanced Property v19.0
Title:
From Item Advanced Property v19.0Form Item Advanced Property
Nested Schema : dataClassificationIds
Type:
Show Source
array-
Array of:
object From Item Advanced Property v19.0
Title:
From Item Advanced Property v19.0Form Item Advanced Property
Nested Schema : e2br3Mapping
Type:
Show Source
array-
Array of:
object From Item Advanced Property v19.0
Title:
From Item Advanced Property v19.0Form Item Advanced Property
Nested Schema : FormNumberItemDto v19.0
Type:
objectTitle:
FormNumberItemDto v19.0Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormNumberItemDto v19.0-allOf[1]
Nested Schema : FormChoiceItemDto v19.0
Type:
objectTitle:
FormChoiceItemDto v19.0Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormChoiceItemDto v19.0-allOf[1]
Nested Schema : FormTextItemDto v19.0
Type:
objectTitle:
FormTextItemDto v19.0Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormTextItemDto v19.0-allOf[1]
Nested Schema : FormDatetimeItemDto v19.0
Type:
objectTitle:
FormDatetimeItemDto v19.0Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormDatetimeItemDto v19.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v19.0
Type:
objectTitle:
FormQuestionGroupItemDto v19.0Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information
Nested Schema : FormTableItemDto v19.0
Type:
objectTitle:
FormTableItemDto v19.0Form table Item Details Information
Match All
Form table Item Details Information
Form table Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormTableItemDto v19.0-allOf[1]
Nested Schema : FormSectionalItemDto v19.0
Type:
objectTitle:
FormSectionalItemDto v19.0Form Section Item Details Information
Match All
Form Section Item Details Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information
Nested Schema : FormLabelItemDto
Type:
objectMatch All
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormLabelItemDto-allOf[1]
Nested Schema : FormInstructionalTextItem v19.0
Type:
objectTitle:
FormInstructionalTextItem v19.0Instructional information about the form or question
Match All
Instructional information about the form or question
Instructional information about the form or question
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormInstructionalTextItem v19.0-allOf[1]
Nested Schema : FormExistingDataItemDtov19
Type:
objectForm existing data item Information
Match All
Form existing data item Information
Form existing data item Information
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information -
object
FormExistingDataItemDtov19-allOf[1]
Nested Schema : FormFileUploadItemDto
Type:
objectMatch All
Show Source
-
object
FormItemDto v19.0
Title:
FormItemDto v19.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }Form Item Information
Nested Schema : From Item Advanced Property v19.0
Type:
objectTitle:
From Item Advanced Property v19.0Form Item Advanced Property
Show Source
-
id: string
(uuid)
Extended Property ID
-
label: string
Rollover study nameExample:
Rollover Study BT-31 -
name: string
Minimum Length:
1Maximum Length:255Advanced property nameExample:RolloverQuestionStudyId -
rules: array
rules
-
value: 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 v19.0
Title:
From Item Advanced Property Rule v19.0Form Item Advanced Property Rule
Nested Schema : FormNumberItemDto v19.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 v19.0-allOf[1]
Type:
Show Source
object-
advancedProps: array
advancedProps
-
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|radioset|labelForm 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 v19.0
Title:
From Item Advanced Property With Parent v19.0Form Item Advanced Property with Parent Info
Nested Schema : options
Type:
Show Source
array-
Array of:
object FormOptionDto v19.0
Title:
FormOptionDto v19.0Form choice item option details
Nested Schema : FormOptionDto v19.0
Type:
objectTitle:
FormOptionDto v19.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 -
clItemId: string
(uuid)
Codelist item id for a one specific choice.
-
clValue: string
Codelist value for a one specific choice.Example:
1 - hidden: boolean
-
label: string
Minimum Length:
1Maximum Length:4000Form choice selectbox label for a one specific choice.Example:Female -
optionSeq: string
Minimum Length:
1Maximum Length:4000Form choice sequence value for a one specific choice.Example:1 -
value: string
Minimum Length:
1Maximum Length:4000Form choice selectbox value for a one specific choice.Example:1
Nested Schema : FormTextItemDto v19.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 v19.0-allOf[1]
Type:
Show Source
object-
allowFutureDate: integer
(int32)
Minimum Value:
0Maximum Value:1Allow future dateExample:1 -
allowPartialDate: integer
(int32)
Minimum Value:
0Maximum Value:1Allow partial dateExample:1 -
format: string
Date time formatExample:
DD-MON-YYYY -
partialDate: string
Partial date formatExample:
Jan-1993
Nested Schema : FormLabelItemDto-allOf[1]
Type:
Show Source
object-
advancedProps: array
advancedProps
-
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|radioset|labelForm 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 v19.0
Title:
From Item Advanced Property With Parent v19.0Form Item Advanced Property with Parent Info
Nested Schema : options
Type:
Show Source
array-
Array of:
object FormOptionDto v19.0
Title:
FormOptionDto v19.0Form choice item option details
Nested Schema : FormInstructionalTextItem v19.0-allOf[1]
Type:
Show Source
object-
instructionalText: string
Instructional information about the form or questionExample:
Complete all parts of the form
Nested Schema : FormExistingDataItemDtov19-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 v19.0
Type:
objectTitle:
FormLinkFromDto v19.0Linked 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:
arrayForm items
Show Source
-
Array of:
object From Item Advanced Property With Parent v19.0
Title:
From Item Advanced Property With Parent v19.0Form Item Advanced Property with Parent Info
Nested Schema : parentAssignedVisits
Type:
arrayParent Assigned Visits
Show Source
-
Array of:
object From Item Advanced Property With Parent v19.0
Title:
From Item Advanced Property With Parent v19.0Form Item Advanced Property with Parent Info
500 Response
Error
Nested Schema : details
Type:
object