Get form item actions assigned to a visit in a study version
post
/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/actionitems
Retrieves form item actions that are assigned to a visit in a study version.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
-
action: string
Return form items with this action.Default Value:
ALL
Allowed Values:[ "autolock", "ALL" ]
-
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
Default Value:
all
-
mode(required): string
Study mode to filter study forms.Allowed Values:
[ "test", "training", "active" ]
Supported Media Types
- */*
Nested Schema : StudyVersionVisitDtoV9
Type:
Show Source
object
-
studyId: string
(uuid)
-
studyTitle: string
Study nameExample:
Study 03
-
version: string
versionExample:
1.3.0.6
-
versionPreviousStatus: string
Allowed Values:
[ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]
Previous study statusExample:TESTING
-
versionStatus: string
Study version statusExample:
Active, not recruiting
-
visitId: string
(uuid)
Visit GUID
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Nested Schema : actions
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