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
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : FormSummaryDto v2.0
Type: object
Title: FormSummaryDto v2.0
Reduced form properties
Show Source
Nested Schema : items
Type: array
Show Source
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
Nested Schema : dataClassificationIds
Type: array
Show Source
Nested Schema : From Item Advanced Property v7.0
Type: object
Title: From Item Advanced Property v7.0
Form Item Advanced Property
Show Source
Nested Schema : rules
Type: array
Show Source
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
  • For RolloverQuestion property it is an ECD_CODELISTITEM.OBJECT_DESCRIPTION
    Example: Yes
  • name
    Example: Answer for Rollover
  • For RolloverQuestion property it is an ECD_CODELISTITEM.CODELISTITEM_ID
    Example: B1B8327AFAA6412287106192AB5984EF

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : details
Type: object
Back to Top