Get all or specified form items in a study
post
/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/formSummaryInfo
Retrieves all or specified latest form items in a study by mode.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
-
items: string
-
mode(required): string
The mode to retrieves all form items for.Allowed Values:
[ "test", "training", "active" ]
Supported Media Types
- */*
Root Schema : schema
Type:
Show Source
array
-
Array of:
string
Example:
C138D4523012443F93F34CC3F281B675
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object FormSummaryInfoDto v1.0
Title:
FormSummaryInfoDto v1.0
Reduced form properties
Nested Schema : FormSummaryInfoDto v1.0
Type:
object
Title:
FormSummaryInfoDto v1.0
Reduced form properties
Show Source
-
id: string
(uuid)
Form Unique GUID
-
items: array
items
-
refname: string
Form refnameExample:
FORM_01
-
title: string
Form titleExample:
Demography
Nested Schema : items
Type:
Show Source
array
-
Array of:
object FormItemSummaryInfoDto v1.0
Title:
FormItemSummaryInfoDto v1.0
Reduced form item properties
Nested Schema : FormItemSummaryInfoDto v1.0
Type:
object
Title:
FormItemSummaryInfoDto v1.0
Reduced form item properties
Show Source
-
id: string
(uuid)
Form Item UUID
-
precision: integer
(int32)
Number value precisionExample:
1
-
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
-
readOnly: boolean
Is form item read only?Example:
false
-
refname: string
Form item reference name.Example:
NUMBER_01
-
studyVersion: string
Study versionExample:
1.0.0.1
-
subItemIds: string
(uuid)
Title:
Sub item ids
List of sub question ids -
units: string
Units of measureExample:
kg
500 Response
Error
Nested Schema : details
Type:
object