Get all forms

post

/ec-designer-svc/rest/v3.0/studies/{studyId}/allForms

Retrieves all forms.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - */* ()
Root Schema : schema
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RespFormDtoWithStudyVersion
Type: object
Show Source
Nested Schema : assignedVisits
Type: array
branch cycle information describing the visits on which the forms are displayed
Show Source
Nested Schema : formSubcategory
Type: array
Form subcategory list
Show Source
Nested Schema : items
Type: array
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
Nested Schema : linkFrom
Type: array
linked from forms
Show Source
Nested Schema : schema
Type: object
Logo uploaded to fileupload service response name
Show Source
Nested Schema : showFrom
Type: array
show dynamic parent from forms of same visit
Show Source
Nested Schema : FormCopySourceDto v19.0
Type: object
Title: FormCopySourceDto v19.0
Form Copy Source Information
Show Source
Nested Schema : From Item Advanced Property With Parent v19.0
Type: object
Title: From Item Advanced Property With Parent v19.0
Form Item Advanced Property with Parent Info
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : From Item Advanced Property Rule v19.0
Type: object
Title: From Item Advanced Property Rule v19.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 v19.0
Type: object
Title: FormItemDto v19.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 : e2br3Mapping
Type: array
Show Source
Nested Schema : FormNumberItemDto v19.0
Type: object
Title: FormNumberItemDto v19.0
Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormNumberItemDto v19.0-allOf[1]
Nested Schema : FormChoiceItemDto v19.0
Type: object
Title: FormChoiceItemDto v19.0
Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormChoiceItemDto v19.0-allOf[1]
Nested Schema : FormTextItemDto v19.0
Type: object
Title: FormTextItemDto v19.0
Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormTextItemDto v19.0-allOf[1]
Nested Schema : FormDatetimeItemDto v19.0
Type: object
Title: FormDatetimeItemDto v19.0
Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormDatetimeItemDto v19.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v19.0
Type: object
Title: FormQuestionGroupItemDto v19.0
Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
Nested Schema : FormTableItemDto v19.0
Type: object
Title: FormTableItemDto v19.0
Form table Item Details Information
Match All
Form table Item Details Information
Form table Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormTableItemDto v19.0-allOf[1]
Nested Schema : FormSectionalItemDto v19.0
Type: object
Title: FormSectionalItemDto v19.0
Form Section Item Details Information
Match All
Form Section Item Details Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
Nested Schema : FormLabelItemDto
Type: object
Match All
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormLabelItemDto-allOf[1]
Nested Schema : FormInstructionalTextItem v19.0
Type: object
Title: FormInstructionalTextItem v19.0
Instructional information about the form or question
Match All
Instructional information about the form or question
Instructional information about the form or question
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormInstructionalTextItem v19.0-allOf[1]
Nested Schema : FormExistingDataItemDtov19
Type: object
Form existing data item Information
Match All
Form existing data item Information
Form existing data item Information
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
  • FormExistingDataItemDtov19-allOf[1]
Nested Schema : FormFileUploadItemDto
Type: object
Match All
Show Source
  • FormItemDto v19.0
    Title: FormItemDto v19.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov19", "numeric":"#/components/schemas/FormNumberItemDtov19", "measurement":"#/components/schemas/FormNumberItemDtov19", "text":"#/components/schemas/FormTextItemDtov19", "choice":"#/components/schemas/FormChoiceItemDtov19", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov19", "table":"#/components/schemas/FormTableItemDtov19", "section":"#/components/schemas/FormSectionalItemDtov19", "label":"#/components/schemas/FormInstructionalTextItemDtov19", "existingData":"#/components/schemas/FormExistingDataItemDtov19", "fileUpload":"#/components/schemas/FormFileUploadItemDto" } }
    Form Item Information
Nested Schema : From Item Advanced Property v19.0
Type: object
Title: From Item Advanced Property v19.0
Form Item Advanced Property
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : FormNumberItemDto v19.0-allOf[1]
Type: object
Show Source
Nested Schema : FormChoiceItemDto v19.0-allOf[1]
Type: object
Show Source
Nested Schema : advancedProps
Type: array
Show Source
Nested Schema : options
Type: array
Show Source
Nested Schema : FormOptionDto v19.0
Type: object
Title: FormOptionDto v19.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 item id for a one specific choice.
  • Codelist value for a one specific choice.
    Example: 1
  • Is form item option hidden?
    Example: false
  • 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 sequence value for a one specific choice.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Form choice selectbox value for a one specific choice.
    Example: 1
Nested Schema : FormTextItemDto v19.0-allOf[1]
Type: object
Show Source
Nested Schema : FormDatetimeItemDto v19.0-allOf[1]
Type: object
Show Source
Nested Schema : FormTableItemDto v19.0-allOf[1]
Type: object
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 : FormInstructionalTextItem v19.0-allOf[1]
Type: object
Show Source
Nested Schema : FormExistingDataItemDtov19-allOf[1]
Type: object
Show Source
  • Codelist name for existing data, must be a value from ExistingDataLabels codelist
    Example: EDLSite
  • Codelist value specifying existing data, must be a value from codelist defined in codeName
    Example: SiteName
Nested Schema : FormLinkFromDto v19.0
Type: object
Title: FormLinkFromDto v19.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

404 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : Object
Type: object
Title: Object
Object with error details information.

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top