V2.0

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/forms/{formId}/formitems

Returns form items for a specific form in the requested study mode. Compared with v1.0, this version returns the v17 form item shape and supports item type filtering.

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
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
Nested Schema : FormItemDto v17.0
Type: object
Title: FormItemDto v17.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 v17.0
Type: object
Title: FormNumberItemDto v17.0
Form Number Item Details Information
Match All
Form Number Item Details Information
Form Number Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormNumberItemDto v17.0-allOf[1]
Nested Schema : FormChoiceItemDto v17.0
Type: object
Title: FormChoiceItemDto v17.0
Form Choice Item Details Information
Match All
Form Choice Item Details Information
Form Choice Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormChoiceItemDto v17.0-allOf[1]
Nested Schema : FormTextItemDto v17.0
Type: object
Title: FormTextItemDto v17.0
Form text Item Details Information
Match All
Form text Item Details Information
Form text Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormTextItemDto v17.0-allOf[1]
Nested Schema : FormDatetimeItemDto v17.0
Type: object
Title: FormDatetimeItemDto v17.0
Form DateTime Item Details Information
Match All
Form DateTime Item Details Information
Form DateTime Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormDatetimeItemDto v17.0-allOf[1]
Nested Schema : FormQuestionGroupItemDto v17.0
Type: object
Title: FormQuestionGroupItemDto v17.0
Form Question Group Item Details Information
Match All
Form Question Group Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
Nested Schema : FormTableItemDto v17.0
Type: object
Title: FormTableItemDto v17.0
Form table Item Details Information
Match All
Form table Item Details Information
Form table Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormTableItemDto v17.0-allOf[1]
Nested Schema : FormSectionalItemDto v17.0
Type: object
Title: FormSectionalItemDto v17.0
Form Section Item Details Information
Match All
Form Section Item Details Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
Nested Schema : FormLabelItemDto
Type: object
Match All
Show Source
  • FormItemDto v21.0
    Title: FormItemDto v21.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormLabelItemDto", "instructionalText":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }
    Base schema for a form item returned from a study form. The questionType value identifies the concrete item schema.
  • FormLabelItemDto-allOf[1]
Nested Schema : FormInstructionalTextItem v17.0
Type: object
Title: FormInstructionalTextItem v17.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 v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormInstructionalTextItem v17.0-allOf[1]
Nested Schema : FormExistingDataItemDtoV17
Type: object
Form existing data item Information
Match All
Form existing data item Information
Form existing data item Information
Show Source
  • FormItemDto v17.0
    Title: FormItemDto v17.0
    Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/FormExistingDataItemDtoV17" } }
    Form Item Information
  • FormExistingDataItemDtoV17-allOf[1]
Nested Schema : From Item Advanced Property v17.0
Type: object
Title: From Item Advanced Property v17.0
Form Item Advanced Property
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : From Item Advanced Property Rule v17.0
Type: object
Title: From Item Advanced Property Rule v17.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 : FormNumberItemDto v17.0-allOf[1]
Type: object
Show Source
Nested Schema : FormChoiceItemDto v17.0-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 v17.0
Type: object
Title: From Item Advanced Property With Parent v17.0
Form Item Advanced Property with Parent Info
Show Source
Nested Schema : rules
Type: array
Show Source
Nested Schema : FormOptionDto v17.0
Type: object
Title: FormOptionDto v17.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 v17.0-allOf[1]
Type: object
Show Source
Nested Schema : FormDatetimeItemDto v17.0-allOf[1]
Type: object
Show Source
Nested Schema : FormTableItemDto v17.0-allOf[1]
Type: object
Show Source
Nested Schema : FormItemDto v21.0
Type: object
Title: FormItemDto v21.0
Discriminator: questionType

Discriminator Values

Base schema for a form item returned from a study form. The questionType value identifies the concrete item schema.
Show Source
Match One Schema
Show Source
Example:
{
    "questionType":"text",
    "id":"9E0F5C16D8A94C5E9E0F5C16D8A94C5E",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "visitIds":[
        "7B4F1B4C9E874845A67B2A83251F9012"
    ],
    "formTitle":"Demographics",
    "questionLabel":"Subject Initials",
    "questionHint":"Enter the subject initials.",
    "refname":"SUBJ_INIT",
    "required":true,
    "dynamic":0,
    "hidden":false,
    "readOnly":false,
    "sdvRequired":"NEVER",
    "sequence":1,
    "groupSequence":1,
    "sasVariable":"SUBJINIT",
    "sasLabel":"Subject Initials"
}
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 : FormItemAdvancedPropWithParentDto v21.0
Type: object
Title: FormItemAdvancedPropWithParentDto v21.0
Advanced property associated with a form item and its parent object.
Show Source
Example:
{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "type":"AssignedVisit",
    "name":"Visit",
    "value":"D3D8327AFAA6412287106192AB5984EF",
    "label":"Screening",
    "parentObjectId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "parentObjectLabel":"Demographics",
    "parentObjectLevel":"FORM"
}
Nested Schema : rules
Type: array
Advanced property rules list.
Show Source
Example:
[
    {
        "name":"RolloverQuestionAnswer",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Yes"
    }
]
Nested Schema : FormItemAdvancedPropRuleDto v21.0
Type: object
Title: FormItemAdvancedPropRuleDto v21.0
Rule entry for a form item advanced property.
Show Source
Example:
{
    "name":"RolloverQuestionAnswer",
    "value":"YES",
    "label":"Yes"
}
Nested Schema : FormOptionDto v21.0
Type: object
Title: FormOptionDto v21.0
Selectable option returned for a choice form item.
Show Source
  • Codelist code for the choice option when linked to a codelist.
    Example: F
  • Minimum Length: 1
    Maximum Length: 4000
    Codelist description for the choice option when linked to a codelist.
    Example: Female
  • Codelist item ID for the choice option (UUID, 32-character uppercase hexadecimal string).
  • Codelist value for the choice option when linked to a codelist.
    Example: Female
  • Is form item option hidden?
    Example: false
  • Minimum Length: 1
    Maximum Length: 4000
    Display label for the choice option.
    Example: Female
  • Minimum Length: 1
    Maximum Length: 4000
    Sequence value for ordering the choice option.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Stored answer value for the choice option.
    Example: F
Example:
{
    "label":"Female",
    "value":"F",
    "clCode":"F",
    "clDescription":"Female",
    "clValue":"Female",
    "clItemId":"1F4A6C7E1B8F4D56A23C9F3A0C7D4E21",
    "hidden":false,
    "optionSeq":"1"
}
Nested Schema : FormInstructionalTextItem v17.0-allOf[1]
Type: object
Show Source
Nested Schema : FormExistingDataItemDtoV17-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
Examples

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.
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.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Back to Top