Get all visits, forms and questionnaires

get

/ec-designer-svc/rest/v8.0/studies/{studyId}/studyDesign

Retrieves all the visits, forms and questionnaires in a study ID in one or more study versions and by mode.

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 : StudyDesignDto v9.0
Type: object
Title: StudyDesignDto v9.0
Information about whole study design for subject .
Show Source
Nested Schema : FormDto v16.0
Type: object
Title: FormDto v16.0
Form Info
Show Source
Nested Schema : FormSummaryDto v1.0
Type: object
Title: FormSummaryDto v1.0
Reduced form properties
Show Source
Nested Schema : StudyVersionVisitDtoV9
Type: object
Show Source
Nested Schema : StudyVisitScheduleWithFormIdsDto v8.0
Type: object
Title: StudyVisitScheduleWithFormIdsDto v8.0
Information about visit schedule and visit forms id .
Show Source
Nested Schema : assignedVisits
Type: array
branch cycle information describing the visits on which the forms are displayed
Show Source
Nested Schema : items
Type: array
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
Nested Schema : linkFrom
Type: array
linked from forms
Show Source
Nested Schema : showFrom
Type: array
show dynamic parent from forms of same visit
Show Source
Nested Schema : FormCopySourceDto v16.0
Type: object
Title: FormCopySourceDto v16.0
Form Copy Source Information
Show Source
Nested Schema : From Item Advanced Property With Parent v16.0
Type: object
Title: From Item Advanced Property With Parent v16.0
Form Item Advanced Property with Parent Info
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : From Item Advanced Property Rule v16.0
Type: object
Title: From Item Advanced Property Rule v16.0
Form Item Advanced Property Rule
Show Source
  • For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE
    Example: Yes
  • name
    Example: RolloverQuestionAnswer
  • For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID
    Example: B1B8327AFAA6412287106192AB5984EF
Nested Schema : FormItemDto v16.0
Type: object
Title: FormItemDto v16.0
Discriminator: questionType

Discriminator Values

Form Item Information
Show Source
Match One Schema
Show Source
Nested Schema : advancedProps
Type: array
Show Source
Nested Schema : dataClassificationIds
Type: array
Show Source
Nested Schema : FormNumberItemDto v16.0
Type: object
Title: FormNumberItemDto v16.0
Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
  • FormNumberItemDto v16.0-allOf[1]
Nested Schema : FormChoiceItemDto v16.0
Type: object
Title: FormChoiceItemDto v16.0
Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
  • FormChoiceItemDto v16.0-allOf[1]
Nested Schema : FormTextItemDto v16.0
Type: object
Title: FormTextItemDto v16.0
Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
  • FormTextItemDto v16.0-allOf[1]
Nested Schema : FormDatetimeItemDto v16.0
Type: object
Title: FormDatetimeItemDto v16.0
Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
  • FormDatetimeItemDto v16.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v16.0
Type: object
Title: FormQuestionGroupItemDto v16.0
Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
Nested Schema : FormTableItemDto v16.0
Type: object
Title: FormTableItemDto v16.0
Form table Item Details Information
Match All
Form table Item Details Information
Form table Item Details Information
Show Source
  • FormItemDto v16.0
    Title: FormItemDto v16.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }
    Form Item Information
  • FormTableItemDto v16.0-allOf[1]
Nested Schema : FormLabelItemDto
Type: object
Match All
Show Source
  • FormItemDto v18.0
    Title: FormItemDto v18.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov18", "numeric":"#/components/schemas/FormNumberItemDtov18", "measurement":"#/components/schemas/FormNumberItemDtov18", "text":"#/components/schemas/FormTextItemDtov18", "choice":"#/components/schemas/FormChoiceItemDtov18", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov18", "table":"#/components/schemas/FormTableItemDtov18", "section":"#/components/schemas/FormSectionalItemDtov18", "label":"#/components/schemas/FormInstructionalTextItemDtov18", "existingData":"#/components/schemas/FormExistingDataItemDtoV18" } }
    Form Item Information
  • FormLabelItemDto-allOf[1]
Nested Schema : From Item Advanced Property v16.0
Type: object
Title: From Item Advanced Property v16.0
Form Item Advanced Property
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : FormNumberItemDto v16.0-allOf[1]
Type: object
Show Source
Nested Schema : FormChoiceItemDto v16.0-allOf[1]
Type: object
Show Source
Nested Schema : advancedProps
Type: array
Show Source
Nested Schema : options
Type: array
Show Source
Nested Schema : FormOptionDto v16.0
Type: object
Title: FormOptionDto v16.0
Form choice item option details
Show Source
  • Codelist code for a one specific choice.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Codelist description for a one specific choice.
    Example: 1
  • Codelist value for a one specific choice.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Form choice selectbox label for a one specific choice.
    Example: Female
  • Minimum Length: 1
    Maximum Length: 4000
    Form choice selectbox value for a one specific choice.
    Example: 1
Nested Schema : FormTextItemDto v16.0-allOf[1]
Type: object
Show Source
Nested Schema : FormDatetimeItemDto v16.0-allOf[1]
Type: object
Show Source
Nested Schema : FormTableItemDto v16.0-allOf[1]
Type: object
Show Source
Nested Schema : FormItemDto v18.0
Type: object
Title: FormItemDto v18.0
Discriminator: questionType

Discriminator Values

Form Item Information
Show Source
Match One Schema
Show Source
Nested Schema : FormLabelItemDto-allOf[1]
Type: object
Show Source
Nested Schema : advancedProps
Type: array
Show Source
Nested Schema : options
Type: array
Show Source
Nested Schema : From Item Advanced Property With Parent v18.0
Type: object
Title: From Item Advanced Property With Parent v18.0
Form Item Advanced Property with Parent Info
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : From Item Advanced Property Rule v18.0
Type: object
Title: From Item Advanced Property Rule v18.0
Form Item Advanced Property Rule
Show Source
  • For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE
    Example: Yes
  • name
    Example: RolloverQuestionAnswer
  • For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID
    Example: B1B8327AFAA6412287106192AB5984EF
Nested Schema : FormOptionDto v18.0
Type: object
Title: FormOptionDto v18.0
Form choice item option details
Show Source
  • Codelist code for a one specific choice.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Codelist description for a one specific choice.
    Example: 1
  • Codelist value for a one specific choice.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Form choice selectbox label for a one specific choice.
    Example: Female
  • Minimum Length: 1
    Maximum Length: 4000
    Form choice selectbox value for a one specific choice.
    Example: 1
Nested Schema : FormLinkFromDto v16.0
Type: object
Title: FormLinkFromDto v16.0
Linked From Form Details
Show Source
Nested Schema : items
Type: array
Form items
Show Source
Nested Schema : parentAssignedVisits
Type: array
Parent Assigned Visits
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : FormItemSummaryDto v1.0
Type: object
Title: FormItemSummaryDto v1.0
Reduced form item properties
Show Source
Nested Schema : formIds
Type: array
List of visit forms IDs
Show Source
Example:
[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]
Nested Schema : StudyVisitScheduleDto v9.0
Type: object
Title: StudyVisitScheduleDto v9.0
Study visit schedule details.
Show Source

500 Response

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