Delete a specific form

delete

/ec-designer-edc-svc/rest/v18.0/studies/{studyId}/versions/{version}/forms/{formId}

Removes a specific form in a study version.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : FormDto v18.0
Type: object
Title: FormDto v18.0
Form Info
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 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
Nested Schema : linkFrom
Type: array
linked from forms
Show Source
Nested Schema : FileUploadRequest
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 v18.0
Type: object
Title: FormCopySourceDto v18.0
Form Copy Source Information
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 : 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 : advancedProps
Type: array
Show Source
Nested Schema : dataClassificationIds
Type: array
Show Source
Nested Schema : FormNumberItemDto v18.0
Type: object
Title: FormNumberItemDto v18.0
Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
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
  • FormNumberItemDto v18.0-allOf[1]
Nested Schema : FormChoiceItemDto v18.0
Type: object
Title: FormChoiceItemDto v18.0
Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
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
  • FormChoiceItemDto v18.0-allOf[1]
Nested Schema : FormTextItemDto v18.0
Type: object
Title: FormTextItemDto v18.0
Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
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
  • FormTextItemDto v18.0-allOf[1]
Nested Schema : FormDatetimeItemDto v18.0
Type: object
Title: FormDatetimeItemDto v18.0
Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
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
  • FormDatetimeItemDto v18.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v18.0
Type: object
Title: FormQuestionGroupItemDto v18.0
Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
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
Nested Schema : FormTableItemDto v18.0
Type: object
Title: FormTableItemDto v18.0
Form table Item Details Information
Match All
Form table Item Details Information
Form table Item Details Information
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
  • FormTableItemDto v18.0-allOf[1]
Nested Schema : FormSectionalItemDto v18.0
Type: object
Title: FormSectionalItemDto v18.0
Form Section Item Details Information
Match All
Form Section Item Details Information
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
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 : FormInstructionalTextItem v18.0
Type: object
Title: FormInstructionalTextItem v18.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 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
  • FormInstructionalTextItem v18.0-allOf[1]
Nested Schema : FormExistingDataItemDtoV18
Type: object
Form existing data item Information
Match All
Form existing data item Information
Form existing data item Information
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
  • FormExistingDataItemDtoV18-allOf[1]
Nested Schema : From Item Advanced Property v18.0
Type: object
Title: From Item Advanced Property v18.0
Form Item Advanced Property
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : FormNumberItemDto v18.0-allOf[1]
Type: object
Show Source
Nested Schema : FormChoiceItemDto v18.0-allOf[1]
Type: object
Show Source
Nested Schema : advancedProps
Type: array
Show Source
Nested Schema : options
Type: array
Show Source
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 : FormTextItemDto v18.0-allOf[1]
Type: object
Show Source
Nested Schema : FormDatetimeItemDto v18.0-allOf[1]
Type: object
Show Source
Nested Schema : FormTableItemDto v18.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 v18.0-allOf[1]
Type: object
Show Source
Nested Schema : FormExistingDataItemDtoV18-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 v18.0
Type: object
Title: FormLinkFromDto v18.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

500 Response

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