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
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 v3.0
Type: object
Title: FormSummaryDto v3.0
Reduced form properties
Show Source
Nested Schema : formSubcategory
Type: array
Form subcategory list
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : FormItemSummaryDto v3.0
Type: object
Title: FormItemSummaryDto v3.0
Reduced form item properties
Show Source

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Back to Top