Get form items identified as lab normals in a study
post
/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/forms/labNormalItems
Retrieves form items tagged with LabNormalTag, classified by study version and form ID.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
-
excludeItemType: string
Form Item type to exclude from responseAllowed Values:
[ "instructionalText" ]
-
formCategory: string
Return forms with this Form Category.Default Value:
ALL
Allowed Values:[ "DCS", "NSF", "ALL" ]
-
items: string
-
mode(required): string
Study mode to filter study forms.Allowed Values:
[ "test", "training", "active" ]
Supported Media Types
- */*
Nested Schema : StudyVersionFormDtoV1
Type:
Show Source
object
-
formId(required): string
(uuid)
Form GUID
-
studyId(required): string
(uuid)
Study GUID
-
version(required): string
versionExample:
1.3.0.6
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object LabNormalFormItemsDto v1.0
Title:
LabNormalFormItemsDto v1.0
LabNormal Form Items Detail Information
Nested Schema : LabNormalFormItemsDto v1.0
Type:
object
Title:
LabNormalFormItemsDto v1.0
LabNormal Form Items Detail Information
Show Source
-
forms: object
LabNormalFormDto v1.0
Title:
LabNormalFormDto v1.0
LabNormal Form Detail Information -
studyVersion: string
Study VersionExample:
1.0.0.1
Nested Schema : LabNormalFormDto v1.0
Type:
object
Title:
LabNormalFormDto v1.0
LabNormal Form Detail Information
Show Source
-
formId: string
(uuid)
Form Id
-
items: object
LabNormalItemDto v1.0
Title:
LabNormalItemDto v1.0
Item tagged with labNormalTag Details
Nested Schema : LabNormalItemDto v1.0
Type:
object
Title:
LabNormalItemDto v1.0
Item tagged with labNormalTag Details
Show Source
-
format: string
Date FormatExample:
dd-MMM-yyyy
-
formId: string
(uuid)
Form Id
-
id: string
(uuid)
Item Id
-
labNormalsTag: string
labNormalsTagExample:
Race
-
options: object
FormOptionDto v17.0
Title:
FormOptionDto v17.0
Form choice item option details -
refname: string
Form refnameExample:
FORM_01
Nested Schema : FormOptionDto v17.0
Type:
object
Title:
FormOptionDto v17.0
Form choice item option details
Show Source
-
clCode: string
Codelist code for a one specific choice.Example:
1
-
clDescription: string
Minimum Length:
1
Maximum Length:4000
Codelist description for a one specific choice.Example:1
-
clValue: string
Codelist value for a one specific choice.Example:
1
-
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
Form choice selectbox value for a one specific choice.Example:1
500 Response
Error
Nested Schema : details
Type:
object