Get a list of study forms
get
/ec-designer-svc/rest/v2.0/studies/{studyId}/{mode}/forms
Retrieves a list of forms in a study.
Request
Path Parameters
-
mode(required): string
Study mode to filter study forms.
-
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" ]
-
items: string
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 FormSummaryDto v2.0
Title:
FormSummaryDto v2.0
Reduced form properties
Nested Schema : FormSummaryDto v2.0
Type:
object
Title:
FormSummaryDto v2.0
Reduced form properties
Show Source
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname: string
Form refnameExample:
FORM_01
-
repeat: boolean
Form repeatingExample:
true
-
title: string
Form titleExample:
Demography
Nested Schema : items
Type:
Show Source
array
-
Array of:
object FormItemSummaryFlatDto v2.0
Title:
FormItemSummaryFlatDto v2.0
This DTO is used by an internal API where only limited form item attributes are included dynamically based on a query param.
Nested Schema : FormItemSummaryFlatDto v2.0
Type:
object
Title:
FormItemSummaryFlatDto v2.0
This DTO is used by an internal API where only limited form item attributes are included dynamically based on a query param.
Show Source
-
allowFutureDate: integer
(int32)
Allow future dateExample:
1
-
allowPartialDate: integer
(int32)
Allow partial DatesExample:
1
-
cohortFactor: boolean
-
dataClassificationIds: array
dataClassificationIds
-
display: string
Choice Box displayExample:
selectbox
-
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
-
format: string
Date time formatExample:
MON-YYYY
-
formula: string
Smart item formula.Example:
[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]
-
groupId: string
(uuid)
Form Unique GUID
- 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
-
itemType: string
Item TypeExample:
table
-
partialDate: string
Partial Date FormatExample:
MON-YYYY
-
precision: integer
(int32)
-
questionHint: string
Form question hintExample:
What is your age?
-
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
-
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: string
Form item reference name.Example:
NUMBER_01
-
required: boolean
Whether this form item is requiered or not.Example:
true
-
sasLabel: string
Form Item sasLabelExample:
Adverse Event
-
sasVariable: string
Form Item SASVariableExample:
AE
-
sdvRequired: string
Allowed Values:
[ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]
Source Data Verification TypeExample:NEVER(0),ALWAYS(1),CRITICAL(2)
-
smartItemId: string
(uuid)
Smart item Unique GUID
-
strataFactor: boolean
-
units: string
Nested Schema : dataClassificationIds
Type:
Show Source
array
-
Array of:
object From Item Advanced Property v7.0
Title:
From Item Advanced Property v7.0
Form Item Advanced Property
Nested Schema : From Item Advanced Property v7.0
Type:
object
Title:
From Item Advanced Property v7.0
Form 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.0
Form Item Advanced Property Rule
Nested Schema : From Item Advanced Property Rule v7.0
Type:
object
Title:
From Item Advanced Property Rule v7.0
Form 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
500 Response
Error
Nested Schema : details
Type:
object