[Deprecated]: Get list of forms in a study
get
/ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms
Deprecated: Use latest version instead. Retrieves all forms added to a specific visit in a study.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
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 v7.0
Title:
FormDto v7.0Form Info
Nested Schema : FormDto v7.0
Type:
objectTitle:
FormDto v7.0Form Info
Show Source
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname(required): string
Minimum Length:
1Maximum Length:64Form refnameExample:FORM_01 -
title(required): string
Minimum Length:
1Maximum Length:64Form titleExample:Demography
Nested Schema : items
Type:
Show Source
array-
Array of:
object FormItemDto v7.0
Title:
FormItemDto v7.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV7", "numeric":"#/components/schemas/FormNumberItemDtoV7", "measurement":"#/components/schemas/FormNumberItemDtoV7", "text":"#/components/schemas/FormTextItemDtoV7", "choice":"#/components/schemas/FormChoiceItemDtoV7" } }Form Item Information
Nested Schema : FormItemDto v7.0
Type:
objectTitle:
FormItemDto v7.0Discriminator: questionType
Discriminator Values
Form Item Information
Show Source
-
advancedProps: array
advancedProps
-
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)'}] -
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 -
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} -
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 v7.0
Title:
FormNumberItemDto v7.0Form Number Item Details Information -
object
FormChoiceItemDto v7.0
Title:
FormChoiceItemDto v7.0Form Choice Item Details Information -
object
FormTextItemDto v7.0
Title:
FormTextItemDto v7.0Form text Item Details Information -
object
FormDatetimeItemDto v7.0
Title:
FormDatetimeItemDto v7.0Form DateTime Item Details Information
Nested Schema : advancedProps
Type:
Show Source
array-
Array of:
object From Item Advanced Property v7.0
Title:
From Item Advanced Property v7.0Form Item Advanced Property
Nested Schema : FormNumberItemDto v7.0
Type:
objectTitle:
FormNumberItemDto v7.0Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
-
object
FormItemDto v7.0
Title:
FormItemDto v7.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV7", "numeric":"#/components/schemas/FormNumberItemDtoV7", "measurement":"#/components/schemas/FormNumberItemDtoV7", "text":"#/components/schemas/FormTextItemDtoV7", "choice":"#/components/schemas/FormChoiceItemDtoV7" } }Form Item Information -
object
FormNumberItemDto v7.0-allOf[1]
Nested Schema : FormChoiceItemDto v7.0
Type:
objectTitle:
FormChoiceItemDto v7.0Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
-
object
FormItemDto v7.0
Title:
FormItemDto v7.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV7", "numeric":"#/components/schemas/FormNumberItemDtoV7", "measurement":"#/components/schemas/FormNumberItemDtoV7", "text":"#/components/schemas/FormTextItemDtoV7", "choice":"#/components/schemas/FormChoiceItemDtoV7" } }Form Item Information -
object
FormChoiceItemDto v7.0-allOf[1]
Nested Schema : FormTextItemDto v7.0
Type:
objectTitle:
FormTextItemDto v7.0Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
-
object
FormItemDto v7.0
Title:
FormItemDto v7.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV7", "numeric":"#/components/schemas/FormNumberItemDtoV7", "measurement":"#/components/schemas/FormNumberItemDtoV7", "text":"#/components/schemas/FormTextItemDtoV7", "choice":"#/components/schemas/FormChoiceItemDtoV7" } }Form Item Information -
object
FormTextItemDto v7.0-allOf[1]
Nested Schema : FormDatetimeItemDto v7.0
Type:
objectTitle:
FormDatetimeItemDto v7.0Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
-
object
FormItemDto v7.0
Title:
FormItemDto v7.0Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV7", "numeric":"#/components/schemas/FormNumberItemDtoV7", "measurement":"#/components/schemas/FormNumberItemDtoV7", "text":"#/components/schemas/FormTextItemDtoV7", "choice":"#/components/schemas/FormChoiceItemDtoV7" } }Form Item Information -
object
FormDatetimeItemDto v7.0-allOf[1]
Nested Schema : From Item Advanced Property v7.0
Type:
objectTitle:
From Item Advanced Property v7.0Form Item Advanced Property
Show Source
-
id: string
(uuid)
Advanced property id
-
label: string
Advanced property label in UI, i.e. studyNameExample:
Study BT-31 -
name: string
Advanced property name, mapped to the ECD_EXTENDED_PROPERTIES.PROPERTY_NAME columnExample:
RolloverQuestion -
parentObjectId: string
(uuid)
-
parentObjectLabel: string
-
parentObjectLevel: string
-
rules: array
rules
-
type: string
Advanced property type, mapped to the ECD_EXTENDED_PROPERTIES.RESPONSE_MAP_JSON column 'valueType' fieldExample:
Dropdown -
value: string
Advanced property value of studyIdExample:
B1B8327AFAA6412287106192AB5984EF
Nested Schema : rules
Type:
Show Source
array-
Array of:
object From Item Advanced Property Rule v7.0
Title:
From Item Advanced Property Rule v7.0Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v7.0
Type:
objectTitle:
From Item Advanced Property Rule v7.0Form Item Advanced Property Rule
Show Source
-
label: string
For RolloverQuestion property it is an ECD_CODELISTITEM.OBJECT_DESCRIPTIONExample:
Yes -
name: string
nameExample:
Answer for Rollover -
value: string
For RolloverQuestion property it is an ECD_CODELISTITEM.CODELISTITEM_IDExample:
B1B8327AFAA6412287106192AB5984EF
Nested Schema : FormNumberItemDto v7.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 v7.0-allOf[1]
Type:
Show Source
object-
display: string
Pattern:
selectboxForm choice item display in UI - Selectbox.Example:selectbox -
options: array
options
Nested Schema : options
Type:
Show Source
array-
Array of:
object FormOptionDto v7.0
Title:
FormOptionDto v7.0Form choice item option details
Nested Schema : FormOptionDto v7.0
Type:
objectTitle:
FormOptionDto v7.0Form choice item option details
Show Source
-
label: string
Minimum Length:
1Maximum Length:4000Form choice selectbox label for a one specific choice.Example:Female -
value: string
Minimum Length:
1Maximum Length:4000Pattern:[a-zA-Z0-9]+Form choice selectbox value for a one specific choice.Example:1
Nested Schema : FormTextItemDto v7.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 v7.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
500 Response
Error
Nested Schema : details
Type:
object