[Deprecated]: Get a specific form
get
/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
Deprecated: Use latest version instead. Retrieves a specific form in a study version.
Request
Path Parameters
-
formId(required): string(uuid)
The Form id
-
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 : FormDto v2.0
Type:
object
Title:
FormDto v2.0
Form Info
Show Source
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname(required): string
Minimum Length:
1
Maximum Length:64
Form refnameExample:FORM_01
-
title(required): string
Minimum Length:
1
Maximum Length:64
Form titleExample:Demography
Nested Schema : items
Type:
Show Source
array
-
Array of:
object FormItemDto v2.0
Title:
FormItemDto v2.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }
Form Item Information
Nested Schema : FormItemDto v2.0
Type:
object
Title:
FormItemDto v2.0
Discriminator: questionType
Discriminator Values
Form Item Information
Show Source
-
formId: string
(uuid)
Form Unique GUID
-
formTitle: string
Form titleExample:
Demography
-
id: string
(uuid)
Form Item Unique GUID
-
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:
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
-
randomizationTag: boolean
Flag that indicates whether this form item should be used for randomization stratification or not.Example:
true
-
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}
-
sdvRequired(required): boolean
Source-Documented Verification: Whether proof of the answer required?Example:
false
-
sequence: integer
(int32)
Item position in the form.Example:
1
Match One Schema
Show Source
-
object
FormNumberItemDto v2.0
Title:
FormNumberItemDto v2.0
Form Number Item Details Information -
object
FormChoiceItemDto v2.0
Title:
FormChoiceItemDto v2.0
Form Choice Item Details Information -
object
FormTextItemDto v2.0
Title:
FormTextItemDto v2.0
Form text Item Details Information -
object
FormDatetimeItemDto v2.0
Title:
FormDatetimeItemDto v2.0
Form DateTime Item Details Information
Nested Schema : FormNumberItemDto v2.0
Type:
object
Title:
FormNumberItemDto v2.0
Form Number Item Details Information
Match All
Show Source
-
object
FormItemDto v2.0
Title:
FormItemDto v2.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }
Form Item Information -
object
FormNumberItemDto v2.0-allOf[1]
Nested Schema : FormChoiceItemDto v2.0
Type:
object
Title:
FormChoiceItemDto v2.0
Form Choice Item Details Information
Match All
Show Source
-
object
FormItemDto v2.0
Title:
FormItemDto v2.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }
Form Item Information -
object
FormChoiceItemDto v2.0-allOf[1]
Nested Schema : FormTextItemDto v2.0
Type:
object
Title:
FormTextItemDto v2.0
Form text Item Details Information
Match All
Show Source
-
object
FormItemDto v2.0
Title:
FormItemDto v2.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }
Form Item Information -
object
FormTextItemDto v2.0-allOf[1]
Nested Schema : FormDatetimeItemDto v2.0
Type:
object
Title:
FormDatetimeItemDto v2.0
Form DateTime Item Details Information
Match All
Show Source
-
object
FormItemDto v2.0
Title:
FormItemDto v2.0
Discriminator:{ "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }
Form Item Information -
object
FormDatetimeItemDto v2.0-allOf[1]
Nested Schema : FormNumberItemDto v2.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 v2.0-allOf[1]
Type:
Show Source
object
-
display: string
Pattern:
selectbox
Form choice item display in UI - Selectbox.Example:selectbox
-
options: array
options
Nested Schema : options
Type:
Show Source
array
-
Array of:
object FormOptionDto v2.0
Title:
FormOptionDto v2.0
Form choice item option details
Nested Schema : FormOptionDto v2.0
Type:
object
Title:
FormOptionDto v2.0
Form choice item option details
Show Source
-
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
Pattern:[a-zA-Z0-9]+
Form choice selectbox value for a one specific choice.Example:1
Nested Schema : FormTextItemDto v2.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 v2.0-allOf[1]
Type:
Show Source
object
-
allowPartialDate: integer
(int32)
Minimum Value:
0
Maximum Value:1
Allow partial dateExample:1
-
format: string
Pattern:
yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm
Date time formatExample:DD-MON-YYYY
-
partialDate: string
Pattern:
yyyy|MMM-yyyy
Partial date formatExample:MMM-yyyy
500 Response
Error
Nested Schema : details
Type:
object