Get a list of study forms
get
/ec-designer-svc/rest/v3.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" ]
-
formCategory: string
Return forms with this Form Category.Default Value:
DCS
-
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 v3.0
Title:
FormSummaryDto v3.0
Reduced form properties
Nested Schema : FormSummaryDto v3.0
Type:
object
Title:
FormSummaryDto v3.0
Reduced form properties
Show Source
-
formCategory: string
Form categoryExample:
DCS
-
formSubcategory: array
formSubcategory
Form subcategory list
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname: string
Form refnameExample:
FORM_01
-
title: string
Form titleExample:
Demography
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 FormItemSummaryDto v3.0
Title:
FormItemSummaryDto v3.0
Reduced form item properties
Nested Schema : FormItemSummaryDto v3.0
Type:
object
Title:
FormItemSummaryDto v3.0
Reduced form item properties
Show Source
-
id: string
(uuid)
Form Item Unique GUID
-
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
-
refname: string
Form item reference name.Example:
NUMBER_01
-
subItemIds: string
(uuid)
Title:
Sub item ids
List of sub question ids
500 Response
Error
Nested Schema : details
Type:
object