Jump to

• Request
• Response

V3.0

get

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

Returns the items configured on a specific form for the requested study mode. Provide the study ID, form ID, and mode; the response is a list of form items with question type, label, reference name, ordering, required status, source data verification setting, and type-specific details such as text length, date format, numeric precision, or choice options when applicable.

Request

Path Parameters

• formId(required): string(uuid)
  Form ID (UUID, 32-character uppercase hexadecimal string).

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string).

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• itemType: string
  Optional form item type filter. Provide the query parameter once per item type when filtering by multiple types. When omitted, all available form item types for the form are returned.

  Allowed Values: [ "datetime", "numeric", "measurement", "text", "choice", "questionGroup", "table", "section", "label", "instructionalText", "existingData", "fileUpload" ]

  Example:

  text

• mode(required): string
  Study mode used to select the form items to return.

  Allowed Values: [ "test", "training", "active" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Form items were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemDtov21"
    }
}

Nested Schema : FormItemDto v21.0

Type: object

Title: FormItemDto v21.0

Discriminator: questionType

Discriminator Values

• datetime
• numeric
• measurement
• text
• choice
• questionGroup
• table
• section
• label
• instructionalText
• existingData
• fileUpload

{
    "title":"FormItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Form item type. Possible values include text, datetime, numeric, choice, questionGroup, instructionalText, existingData, table, section, label, and fileUpload.",
            "example":"text",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form item ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "visitIds":{
            "type":"array",
            "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
            "format":"List<UUID>",
            "example":[
                "7B4F1B4C9E874845A67B2A83251F9012",
                "8C5F1B4C9E874845A67B2A83251F9013"
            ],
            "items":{
                "type":"string",
                "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
                "format":"uuid"
            }
        },
        "formTitle":{
            "type":"string",
            "description":"Title of the form that contains the item.",
            "example":"Demographics"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "required":{
            "type":"boolean",
            "description":"Indicates whether an answer is required for this form item.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"Number of preceding questions that must be answered before this dynamic item is included in the form.",
            "format":"int32",
            "example":0
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of validation rules for the answer.",
            "example":"{\"logicalOperator\":\"NONE\",\"rules\":[],\"numberIndex\":1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source data verification setting. Possible values are NOTSET, NEVER, ALWAYS, and CRITICAL.",
            "example":"NEVER"
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32",
            "example":3
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{\"ruleName\":\"AGE\",\"ruleExpression\":\"AgeInYears(AGE_DOB_01, visitDate)\"}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"SAS variable name for the form item when configured.",
            "example":"SUBJINIT"
        },
        "sasLabel":{
            "type":"string",
            "description":"SAS label for the form item when configured.",
            "example":"Subject Initials"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "description":"Data classification entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"DATA_CLASSIFICATION",
                    "name":"CLASSIFICATION_ID",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Confidential"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "requiredScreening":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for screening event minimum data collection.",
            "example":true
        },
        "requiredRandomization":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for randomization event minimum data collection.",
            "example":false
        },
        "requiredDispensation":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for dispensation event minimum data collection.",
            "example":false
        },
        "requiredForCaseCreate":{
            "type":"boolean",
            "description":"Indicates whether the form item is required for safety case creation minimum data collection.",
            "example":false
        },
        "triggerFollowupCase":{
            "type":"boolean",
            "description":"Indicates whether the form item can trigger a follow-up safety case.",
            "example":false
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        },
        "e2br3Mapping":{
            "type":"array",
            "description":"E2B R3 mapping entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"E2BR3",
                    "name":"E2B_FIELD",
                    "value":"PATIENT_AGE",
                    "label":"Patient Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        }
    },
    "description":"Base schema for a form item returned from a study form. The questionType value identifies the concrete item schema.",
    "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"
    },
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormExistingDataItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormFileUploadItemDtov21"
        }
    ]
}

Base schema for a form item returned from a study form. The questionType value identifies the concrete item schema.

Show Source

• advancedProps: array advancedProps
• applyChangeToVersion: string
  For IPR apply change to version

  Example: 1.0.0.1
• clLabNormalsTag: string
  Code list Lab Normals Tag used in the code list dialog tagging

  Example: LabTest, LabUnit, LabGender, LabRace, LabStandardResult
• dataClassificationIds: array dataClassificationIds
  Data classification entries.
• dataClassificationLevel: string
  Data classification level if applicable

  Example: edit, view
• dynamic: integer (int32)
  Number of preceding questions that must be answered before this dynamic item is included in the form.

  Example: 0
• e2br3Mapping: array e2br3Mapping
  E2B R3 mapping entries.
• formId: string (uuid)
  Form ID (UUID, 32-character uppercase hexadecimal string).
• formTitle: string
  Title of the form that contains the item.

  Example: Demographics
• formula: string
  Smart item formula.

  Example: [{"ruleName":"AGE","ruleExpression":"AgeInYears(AGE_DOB_01, visitDate)"}]
• groupSequence: integer (int32)
  Group sequence.

  Example: 3
• hidden: boolean
  Is form item hidden?

  Example: false
• id: string (uuid)
  Form item ID (UUID, 32-character uppercase hexadecimal string).
• isCohortFactor: boolean
  Flag that indicates whether this form item is used as a factor for randomization cohort or not.

  Example: false
• isStrataFactor: boolean
  Flag that indicates whether this form item is used as a factor for randomization stratum or not.

  Example: false
• labNormalsTag: string
  Lab Normals Tag used in dialog tagging

  Example: LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult
• questionHint: string
  Minimum Length: 0

  Maximum Length: 4000

  Form question hint

  Example: What is your age?
• questionLabel(required): string
  Minimum Length: 1

  Maximum Length: 4000

  Form question label

  Example: Age
• questionType(required): string
  Title: FormItemType

  Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]

  Form item type. Possible values include text, datetime, numeric, choice, questionGroup, instructionalText, existingData, table, section, label, and fileUpload.

  Example: text
• randomizationTag: boolean
  Flag that indicates whether this form item should be used for randomization stratification or not.

  Example: true
• readOnly: boolean
  Is form item read only?

  Example: false
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form item reference name.

  Example: NUMBER_01
• required(required): boolean
  Indicates whether an answer is required for this form item.

  Example: true
• requiredDispensation: boolean
  Indicates whether the form item is tagged as required for dispensation event minimum data collection.

  Example: false
• requiredForCaseCreate: boolean
  Indicates whether the form item is required for safety case creation minimum data collection.

  Example: false
• requiredRandomization: boolean
  Indicates whether the form item is tagged as required for randomization event minimum data collection.

  Example: false
• requiredScreening: boolean
  Indicates whether the form item is tagged as required for screening event minimum data collection.

  Example: true
• ruleSet: string
  A JSON-formatted set of validation rules for the answer.

  Example: {"logicalOperator":"NONE","rules":[],"numberIndex":1}
• sasLabel: string
  SAS label for the form item when configured.

  Example: Subject Initials
• sasVariable: string
  SAS variable name for the form item when configured.

  Example: SUBJINIT
• sdvRequired(required): string
  Source data verification setting. Possible values are NOTSET, NEVER, ALWAYS, and CRITICAL.

  Example: NEVER
• sequence: integer (int32)
  Item position in the form.

  Example: 1
• smartItemId: string (uuid)
  Smart item ID (UUID, 32-character uppercase hexadecimal string).
• smartObject: string
  Smart object.

  Example: AGE
• triggerFollowupCase: boolean
  Indicates whether the form item can trigger a follow-up safety case.

  Example: false
• visitIds: array visitIds
  Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.

{
    "title":"FormItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Form item type. Possible values include text, datetime, numeric, choice, questionGroup, instructionalText, existingData, table, section, label, and fileUpload.",
            "example":"text",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form item ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "visitIds":{
            "type":"array",
            "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
            "format":"List<UUID>",
            "example":[
                "7B4F1B4C9E874845A67B2A83251F9012",
                "8C5F1B4C9E874845A67B2A83251F9013"
            ],
            "items":{
                "type":"string",
                "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
                "format":"uuid"
            }
        },
        "formTitle":{
            "type":"string",
            "description":"Title of the form that contains the item.",
            "example":"Demographics"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "required":{
            "type":"boolean",
            "description":"Indicates whether an answer is required for this form item.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"Number of preceding questions that must be answered before this dynamic item is included in the form.",
            "format":"int32",
            "example":0
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of validation rules for the answer.",
            "example":"{\"logicalOperator\":\"NONE\",\"rules\":[],\"numberIndex\":1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source data verification setting. Possible values are NOTSET, NEVER, ALWAYS, and CRITICAL.",
            "example":"NEVER"
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32",
            "example":3
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{\"ruleName\":\"AGE\",\"ruleExpression\":\"AgeInYears(AGE_DOB_01, visitDate)\"}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"SAS variable name for the form item when configured.",
            "example":"SUBJINIT"
        },
        "sasLabel":{
            "type":"string",
            "description":"SAS label for the form item when configured.",
            "example":"Subject Initials"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "description":"Data classification entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"DATA_CLASSIFICATION",
                    "name":"CLASSIFICATION_ID",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Confidential"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "requiredScreening":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for screening event minimum data collection.",
            "example":true
        },
        "requiredRandomization":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for randomization event minimum data collection.",
            "example":false
        },
        "requiredDispensation":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for dispensation event minimum data collection.",
            "example":false
        },
        "requiredForCaseCreate":{
            "type":"boolean",
            "description":"Indicates whether the form item is required for safety case creation minimum data collection.",
            "example":false
        },
        "triggerFollowupCase":{
            "type":"boolean",
            "description":"Indicates whether the form item can trigger a follow-up safety case.",
            "example":false
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        },
        "e2br3Mapping":{
            "type":"array",
            "description":"E2B R3 mapping entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"E2BR3",
                    "name":"E2B_FIELD",
                    "value":"PATIENT_AGE",
                    "label":"Patient Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        }
    },
    "description":"Base schema for a form item returned from a study form. The questionType value identifies the concrete item schema.",
    "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"
    },
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormExistingDataItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormFileUploadItemDtov21"
        }
    ]
}

Match One Schema

Show Source

• object FormNumberItemDto v21.0
  Title: FormNumberItemDto v21.0

  Numeric or measurement form item returned from a study form.
• object FormChoiceItemDto v21.0
  Title: FormChoiceItemDto v21.0

  Choice form item returned from a study form, including selectable options when configured.
• object FormTextItemDto v21.0
  Title: FormTextItemDto v21.0

  Text form item returned from a study form.
• object FormDatetimeItemDto v21.0
  Title: FormDatetimeItemDto v21.0

  Date or date-time form item returned from a study form.
• object FormQuestionGroupItemDto v21.0
  Title: FormQuestionGroupItemDto v21.0

  Question group form item returned from a study form. Nested items contain the questions in the group.
• object FormTableItemDto v21.0
  Title: FormTableItemDto v21.0

  Form Table Item Details Information
• object FormSectionalItemDto v21.0
  Title: FormSectionalItemDto v21.0

  Form Sectional Item Details Information
• object FormLabelItemDto
• object FormInstructionalTextItemDto v21.0
  Title: FormInstructionalTextItemDto v21.0

  Instructional text item returned from a study form.
• object FormExistingDataItemDto v21.0
  Title: FormExistingDataItemDto v21.0

  Existing-data form item returned from a study form.
• object FormFileUploadItemDto v21.0
  Title: FormFileUploadItemDto v21.0

  Form File Upload Item Details Information

{
    "title":"FormItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Form item type. Possible values include text, datetime, numeric, choice, questionGroup, instructionalText, existingData, table, section, label, and fileUpload.",
            "example":"text",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form item ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "visitIds":{
            "type":"array",
            "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
            "format":"List<UUID>",
            "example":[
                "7B4F1B4C9E874845A67B2A83251F9012",
                "8C5F1B4C9E874845A67B2A83251F9013"
            ],
            "items":{
                "type":"string",
                "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
                "format":"uuid"
            }
        },
        "formTitle":{
            "type":"string",
            "description":"Title of the form that contains the item.",
            "example":"Demographics"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "required":{
            "type":"boolean",
            "description":"Indicates whether an answer is required for this form item.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"Number of preceding questions that must be answered before this dynamic item is included in the form.",
            "format":"int32",
            "example":0
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of validation rules for the answer.",
            "example":"{\"logicalOperator\":\"NONE\",\"rules\":[],\"numberIndex\":1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source data verification setting. Possible values are NOTSET, NEVER, ALWAYS, and CRITICAL.",
            "example":"NEVER"
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32",
            "example":3
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{\"ruleName\":\"AGE\",\"ruleExpression\":\"AgeInYears(AGE_DOB_01, visitDate)\"}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"SAS variable name for the form item when configured.",
            "example":"SUBJINIT"
        },
        "sasLabel":{
            "type":"string",
            "description":"SAS label for the form item when configured.",
            "example":"Subject Initials"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "description":"Data classification entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"DATA_CLASSIFICATION",
                    "name":"CLASSIFICATION_ID",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Confidential"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "requiredScreening":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for screening event minimum data collection.",
            "example":true
        },
        "requiredRandomization":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for randomization event minimum data collection.",
            "example":false
        },
        "requiredDispensation":{
            "type":"boolean",
            "description":"Indicates whether the form item is tagged as required for dispensation event minimum data collection.",
            "example":false
        },
        "requiredForCaseCreate":{
            "type":"boolean",
            "description":"Indicates whether the form item is required for safety case creation minimum data collection.",
            "example":false
        },
        "triggerFollowupCase":{
            "type":"boolean",
            "description":"Indicates whether the form item can trigger a follow-up safety case.",
            "example":false
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        },
        "e2br3Mapping":{
            "type":"array",
            "description":"E2B R3 mapping entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"E2BR3",
                    "name":"E2B_FIELD",
                    "value":"PATIENT_AGE",
                    "label":"Patient Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        }
    },
    "description":"Base schema for a form item returned from a study form. The questionType value identifies the concrete item schema.",
    "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"
    },
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormExistingDataItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormFileUploadItemDtov21"
        }
    ]
}

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 : advancedProps

Type: array

Show Source

• Array of: object FormItemAdvancedPropDto v21.0
  Title: FormItemAdvancedPropDto v21.0

  Advanced property associated with a form item.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
    }
}

Nested Schema : dataClassificationIds

Type: array

Data classification entries.

Show Source

• Array of: object FormItemAdvancedPropDto v21.0
  Title: FormItemAdvancedPropDto v21.0

  Advanced property associated with a form item.

{
    "type":"array",
    "description":"Data classification entries.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "type":"DATA_CLASSIFICATION",
            "name":"CLASSIFICATION_ID",
            "value":"B1B8327AFAA6412287106192AB5984EF",
            "label":"Confidential"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "type":"DATA_CLASSIFICATION",
        "name":"CLASSIFICATION_ID",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Confidential"
    }
]

Nested Schema : e2br3Mapping

Type: array

E2B R3 mapping entries.

Show Source

• Array of: object FormItemAdvancedPropDto v21.0
  Title: FormItemAdvancedPropDto v21.0

  Advanced property associated with a form item.

{
    "type":"array",
    "description":"E2B R3 mapping entries.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "type":"E2BR3",
            "name":"E2B_FIELD",
            "value":"PATIENT_AGE",
            "label":"Patient Age"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "type":"E2BR3",
        "name":"E2B_FIELD",
        "value":"PATIENT_AGE",
        "label":"Patient Age"
    }
]

Nested Schema : visitIds

Type: array

Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.

Show Source

• Array of: string(uuid)
  Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.

{
    "type":"array",
    "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
    "format":"List<UUID>",
    "example":[
        "7B4F1B4C9E874845A67B2A83251F9012",
        "8C5F1B4C9E874845A67B2A83251F9013"
    ],
    "items":{
        "type":"string",
        "description":"Visit IDs associated with this form item. Each value is a UUID, 32-character uppercase hexadecimal string.",
        "format":"uuid"
    }
}

Example:

[
    "7B4F1B4C9E874845A67B2A83251F9012",
    "8C5F1B4C9E874845A67B2A83251F9013"
]

Nested Schema : FormNumberItemDto v21.0

Type: object

Title: FormNumberItemDto v21.0

Numeric or measurement form item returned from a study form.

Match All

Numeric or measurement form item returned from a study form.

Numeric or measurement form item returned from a study form.

Show Source

• object 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.
• object FormNumberItemDto v21.0-allOf[1]

{
    "title":"FormNumberItemDto v21.0",
    "required":[
        "precision",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Numeric or measurement form item returned from a study form.",
    "example":{
        "questionType":"numeric",
        "id":"2C6A91D5D3384DA8B8E8DD1A28B69E31",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Vitals",
        "questionLabel":"Weight",
        "refname":"WEIGHT",
        "required":true,
        "sdvRequired":"ALWAYS",
        "sequence":2,
        "precision":1,
        "units":"kg"
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "precision":{
                    "minimum":0,
                    "type":"integer",
                    "description":"Number of digits allowed after the decimal point. Minimum value: 0.",
                    "format":"int32",
                    "example":1
                },
                "units":{
                    "type":"string",
                    "description":"Unit of measure displayed with the numeric answer when configured.",
                    "example":"kg"
                }
            }
        }
    ]
}

Example:

{
    "questionType":"numeric",
    "id":"2C6A91D5D3384DA8B8E8DD1A28B69E31",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Vitals",
    "questionLabel":"Weight",
    "refname":"WEIGHT",
    "required":true,
    "sdvRequired":"ALWAYS",
    "sequence":2,
    "precision":1,
    "units":"kg"
}

Nested Schema : FormChoiceItemDto v21.0

Type: object

Title: FormChoiceItemDto v21.0

Choice form item returned from a study form, including selectable options when configured.

Match All

Choice form item returned from a study form, including selectable options when configured.

Choice form item returned from a study form, including selectable options when configured.

Show Source

• object 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.
• object FormChoiceItemDto v21.0-allOf[1]

{
    "title":"FormChoiceItemDto v21.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Choice form item returned from a study form, including selectable options when configured.",
    "example":{
        "questionType":"choice",
        "id":"4A9CE0F0A13A4F4C903C18EBB8B1C552",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Demographics",
        "questionLabel":"Sex",
        "refname":"SEX",
        "required":true,
        "sdvRequired":"NEVER",
        "sequence":4,
        "display":"radioset",
        "columnLayout":"EBCF17C5F8D4460AA4A9673485C79CF0",
        "columnLayoutLabel":"Single",
        "options":[
            {
                "label":"Female",
                "value":"F",
                "clCode":"F",
                "clDescription":"Female",
                "clValue":"Female",
                "clItemId":"1F4A6C7E1B8F4D56A23C9F3A0C7D4E21",
                "hidden":false,
                "optionSeq":"1"
            }
        ],
        "clTitle":"Sex",
        "clDescription":"Standard sex codelist",
        "isCodeListReplaced":false,
        "codelistLinkType":"STATIC",
        "codelistId":"EBCF17C5F8D4460AA4A9673485C79CF0",
        "codelistLang":"en-US"
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "advancedProps":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
                    }
                },
                "display":{
                    "pattern":"selectbox|checkbox|radioset|label",
                    "type":"string",
                    "description":"Display control used for the choice item. Allowed values: selectbox, checkbox, radioset, or label.",
                    "example":"radioset"
                },
                "columnLayout":{
                    "type":"string",
                    "description":"Column layout codelist ID (UUID, 32-character uppercase hexadecimal string).",
                    "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
                },
                "columnLayoutLabel":{
                    "type":"string",
                    "description":"Column layout label displayed for the choice item.",
                    "example":"Single"
                },
                "options":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormOptionDtov21"
                    }
                },
                "clTitle":{
                    "type":"string",
                    "description":"Codelist title only for choice type formitem",
                    "example":"Gender"
                },
                "clDescription":{
                    "maxLength":4000,
                    "minLength":0,
                    "type":"string",
                    "description":"Codelist description only for choice type formitem",
                    "example":"Standard gender codelist"
                },
                "isCodeListReplaced":{
                    "type":"boolean",
                    "description":"Indicates if the choice option codelist is replaced",
                    "example":true
                },
                "codelistLinkType":{
                    "type":"string",
                    "description":"Indicates whether the codelist mapped to the item is static or dynamic.",
                    "example":"STATIC",
                    "enum":[
                        "STATIC",
                        "DYNAMIC"
                    ]
                },
                "codelistId":{
                    "type":"string",
                    "description":"ID of the codelist used by the choice item (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "codelistLang":{
                    "type":"string",
                    "description":"Language of the codelist used by the choice item.",
                    "example":"en-US"
                }
            }
        }
    ]
}

Example:

{
    "questionType":"choice",
    "id":"4A9CE0F0A13A4F4C903C18EBB8B1C552",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Demographics",
    "questionLabel":"Sex",
    "refname":"SEX",
    "required":true,
    "sdvRequired":"NEVER",
    "sequence":4,
    "display":"radioset",
    "columnLayout":"EBCF17C5F8D4460AA4A9673485C79CF0",
    "columnLayoutLabel":"Single",
    "options":[
        {
            "label":"Female",
            "value":"F",
            "clCode":"F",
            "clDescription":"Female",
            "clValue":"Female",
            "clItemId":"1F4A6C7E1B8F4D56A23C9F3A0C7D4E21",
            "hidden":false,
            "optionSeq":"1"
        }
    ],
    "clTitle":"Sex",
    "clDescription":"Standard sex codelist",
    "isCodeListReplaced":false,
    "codelistLinkType":"STATIC",
    "codelistId":"EBCF17C5F8D4460AA4A9673485C79CF0",
    "codelistLang":"en-US"
}

Nested Schema : FormTextItemDto v21.0

Type: object

Title: FormTextItemDto v21.0

Text form item returned from a study form.

Match All

Text form item returned from a study form.

Text form item returned from a study form.

Show Source

• object 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.
• object FormTextItemDto v21.0-allOf[1]

{
    "title":"FormTextItemDto v21.0",
    "required":[
        "maxlength",
        "multiline",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Text form item returned from a study form.",
    "example":{
        "questionType":"text",
        "id":"9E0F5C16D8A94C5E9E0F5C16D8A94C5E",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Demographics",
        "questionLabel":"Subject Initials",
        "refname":"SUBJ_INIT",
        "required":true,
        "sdvRequired":"NEVER",
        "sequence":1,
        "maxlength":4000,
        "multiline":false
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "maxlength":{
                    "maximum":4000,
                    "minimum":0,
                    "type":"integer",
                    "description":"Maximum number of characters allowed for the text answer. Allowed range: 0 to 4000.",
                    "format":"int32",
                    "example":4000
                },
                "multiline":{
                    "type":"boolean",
                    "description":"Indicates whether the text answer supports multiple lines.",
                    "example":false
                }
            }
        }
    ]
}

Example:

{
    "questionType":"text",
    "id":"9E0F5C16D8A94C5E9E0F5C16D8A94C5E",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Demographics",
    "questionLabel":"Subject Initials",
    "refname":"SUBJ_INIT",
    "required":true,
    "sdvRequired":"NEVER",
    "sequence":1,
    "maxlength":4000,
    "multiline":false
}

Nested Schema : FormDatetimeItemDto v21.0

Type: object

Title: FormDatetimeItemDto v21.0

Date or date-time form item returned from a study form.

Match All

Date or date-time form item returned from a study form.

Date or date-time form item returned from a study form.

Show Source

• object 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.
• object FormDatetimeItemDto v21.0-allOf[1]

{
    "title":"FormDatetimeItemDto v21.0",
    "required":[
        "format",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Date or date-time form item returned from a study form.",
    "example":{
        "questionType":"datetime",
        "id":"D42F5888C55B4E7B9E25F1A7C1F0B8D4",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Demographics",
        "questionLabel":"Date of Birth",
        "refname":"DOB",
        "required":true,
        "sdvRequired":"ALWAYS",
        "sequence":3,
        "format":"DD-MON-YYYY",
        "allowPartialDate":1,
        "partialDate":"MON-YYYY",
        "allowFutureDate":0
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "format":{
                    "type":"string",
                    "description":"Date or date-time display format for the answer.",
                    "example":"DD-MON-YYYY"
                },
                "allowPartialDate":{
                    "maximum":1,
                    "minimum":0,
                    "type":"integer",
                    "description":"Indicates whether partial dates are allowed. Allowed values: 0 or 1.",
                    "format":"int32",
                    "example":1
                },
                "partialDate":{
                    "type":"string",
                    "description":"Partial date format returned when partial dates are allowed.",
                    "example":"MON-YYYY"
                },
                "allowFutureDate":{
                    "maximum":1,
                    "minimum":0,
                    "type":"integer",
                    "description":"Indicates whether future dates are allowed. Allowed values: 0 or 1.",
                    "format":"int32",
                    "example":0
                }
            }
        }
    ]
}

Example:

{
    "questionType":"datetime",
    "id":"D42F5888C55B4E7B9E25F1A7C1F0B8D4",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Demographics",
    "questionLabel":"Date of Birth",
    "refname":"DOB",
    "required":true,
    "sdvRequired":"ALWAYS",
    "sequence":3,
    "format":"DD-MON-YYYY",
    "allowPartialDate":1,
    "partialDate":"MON-YYYY",
    "allowFutureDate":0
}

Nested Schema : FormQuestionGroupItemDto v21.0

Type: object

Title: FormQuestionGroupItemDto v21.0

Question group form item returned from a study form. Nested items contain the questions in the group.

Match All

Question group form item returned from a study form. Nested items contain the questions in the group.

Question group form item returned from a study form. Nested items contain the questions in the group.

Show Source

• object 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.
• object FormQuestionGroupItemDto v21.0-allOf[1]

{
    "title":"FormQuestionGroupItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Question group form item returned from a study form. Nested items contain the questions in the group.",
    "example":{
        "questionType":"questionGroup",
        "id":"6B6C22EAD8AC42F8952E73B9A62219D1",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Medical History",
        "questionLabel":"Medication Details",
        "refname":"MED_GRP",
        "required":false,
        "sdvRequired":"NEVER",
        "sequence":5,
        "items":[
            {
                "questionType":"text",
                "id":"9E0F5C16D8A94C5E9E0F5C16D8A94C5E",
                "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
                "questionLabel":"Medication Name",
                "refname":"MED_NAME",
                "required":true,
                "sdvRequired":"NEVER",
                "sequence":1,
                "maxlength":200,
                "multiline":false
            }
        ]
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemDtov21"
                    }
                }
            }
        }
    ]
}

Example:

{
    "questionType":"questionGroup",
    "id":"6B6C22EAD8AC42F8952E73B9A62219D1",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Medical History",
    "questionLabel":"Medication Details",
    "refname":"MED_GRP",
    "required":false,
    "sdvRequired":"NEVER",
    "sequence":5,
    "items":[
        {
            "questionType":"text",
            "id":"9E0F5C16D8A94C5E9E0F5C16D8A94C5E",
            "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
            "questionLabel":"Medication Name",
            "refname":"MED_NAME",
            "required":true,
            "sdvRequired":"NEVER",
            "sequence":1,
            "maxlength":200,
            "multiline":false
        }
    ]
}

Nested Schema : FormTableItemDto v21.0

Type: object

Title: FormTableItemDto v21.0

Form Table Item Details Information

Match All

Form Table Item Details Information

Form Table Item Details Information

Show Source

• object 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.
• object FormTableItemDto v21.0-allOf[1]

{
    "title":"FormTableItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Table Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemDtov21"
                    }
                },
                "allowAdditionalRows":{
                    "type":"boolean"
                }
            }
        }
    ]
}

Nested Schema : FormSectionalItemDto v21.0

Type: object

Title: FormSectionalItemDto v21.0

Form Sectional Item Details Information

Match All

Form Sectional Item Details Information

Show Source

• object 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.

{
    "title":"FormSectionalItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Sectional Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        }
    ]
}

Nested Schema : FormLabelItemDto

Type: object

Match All

Show Source

• object 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
• object FormLabelItemDto-allOf[1]

{
    "required":[
        "display",
        "options",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov16"
        },
        {
            "type":"object",
            "properties":{
                "advancedProps":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov16"
                    }
                },
                "display":{
                    "pattern":"selectbox|checkbox|radioset|label",
                    "type":"string",
                    "description":"Form choice item display in UI - Selectbox.",
                    "example":"selectbox"
                },
                "columnLayout":{
                    "type":"string",
                    "description":"Coumn Layout codelist ID",
                    "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
                },
                "columnLayoutLabel":{
                    "type":"string",
                    "description":"Coumn Layout Label in UI",
                    "example":"Single"
                },
                "options":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormOptionDtov16"
                    }
                },
                "clTitle":{
                    "type":"string",
                    "description":"Codelist title only for choice type formitem",
                    "example":"Gender"
                },
                "clDescription":{
                    "maxLength":4000,
                    "minLength":0,
                    "type":"string",
                    "description":"Codelist description only for choice type formitem",
                    "example":"Standard gender codelist"
                },
                "isCodeListReplaced":{
                    "type":"boolean",
                    "description":"Indicates if the choice option codelist is replaced",
                    "example":true
                }
            }
        }
    ]
}

Nested Schema : FormInstructionalTextItemDto v21.0

Type: object

Title: FormInstructionalTextItemDto v21.0

Instructional text item returned from a study form.

Match All

Instructional text item returned from a study form.

Instructional text item returned from a study form.

Show Source

• object 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.
• object FormInstructionalTextItemDto v21.0-allOf[1]

{
    "title":"FormInstructionalTextItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Instructional text item returned from a study form.",
    "example":{
        "questionType":"instructionalText",
        "id":"A6BB54DE91324969AB3BC4079E771295",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Demographics",
        "questionLabel":"Instructions",
        "refname":"DEMOG_INST",
        "required":false,
        "sdvRequired":"NEVER",
        "sequence":6,
        "instructionalText":"Please complete all required demographic questions."
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "instructionalText":{
                    "type":"string",
                    "description":"Instructional text displayed with the form item.",
                    "example":"Please complete all required demographic questions."
                }
            }
        }
    ]
}

Example:

{
    "questionType":"instructionalText",
    "id":"A6BB54DE91324969AB3BC4079E771295",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Demographics",
    "questionLabel":"Instructions",
    "refname":"DEMOG_INST",
    "required":false,
    "sdvRequired":"NEVER",
    "sequence":6,
    "instructionalText":"Please complete all required demographic questions."
}

Nested Schema : FormExistingDataItemDto v21.0

Type: object

Title: FormExistingDataItemDto v21.0

Existing-data form item returned from a study form.

Match All

Existing-data form item returned from a study form.

Existing-data form item returned from a study form.

Show Source

• object 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.
• object FormExistingDataItemDto v21.0-allOf[1]

{
    "title":"FormExistingDataItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Existing-data form item returned from a study form.",
    "example":{
        "questionType":"existingData",
        "id":"2E4E9F0B3F124D938E7B70E9527E05D4",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Site Information",
        "questionLabel":"Site Name",
        "refname":"SITE_NAME",
        "required":false,
        "sdvRequired":"NEVER",
        "sequence":7,
        "existingDataCodeName":"EDLSite",
        "existingDataCodeValue":"SiteName"
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "existingDataCodeName":{
                    "type":"string",
                    "description":"Existing-data codelist name. The value must come from the ExistingDataLabels codelist.",
                    "example":"EDLSite"
                },
                "existingDataCodeValue":{
                    "type":"string",
                    "description":"Existing-data codelist value. The value must come from the codelist identified by existingDataCodeName.",
                    "example":"SiteName"
                }
            }
        }
    ]
}

Example:

{
    "questionType":"existingData",
    "id":"2E4E9F0B3F124D938E7B70E9527E05D4",
    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "formTitle":"Site Information",
    "questionLabel":"Site Name",
    "refname":"SITE_NAME",
    "required":false,
    "sdvRequired":"NEVER",
    "sequence":7,
    "existingDataCodeName":"EDLSite",
    "existingDataCodeValue":"SiteName"
}

Nested Schema : FormFileUploadItemDto v21.0

Type: object

Title: FormFileUploadItemDto v21.0

Form File Upload Item Details Information

Match All

Form File Upload Item Details Information

Show Source

• object 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.

{
    "title":"FormFileUploadItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form File Upload Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        }
    ]
}

Nested Schema : FormItemAdvancedPropDto v21.0

Type: object

Title: FormItemAdvancedPropDto v21.0

Advanced property associated with a form item.

Show Source

• id: string (uuid)
  Extended property ID (UUID, 32-character uppercase hexadecimal string).
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name: string
  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
  Advanced property rules list.
• type: string
  Advanced property type.

  Example: RolloverQuestion
• value: string
  Advanced property value. The meaning depends on the advanced property name.

  Example: C2C8327AFAA6412287106192AB5984EF

{
    "title":"FormItemAdvancedPropDto v21.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended property ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Advanced property type.",
            "example":"RolloverQuestion"
        },
        "name":{
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "type":"string",
            "description":"Advanced property value. The meaning depends on the advanced property name.",
            "example":"C2C8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "description":"Advanced property rules list.",
            "example":[
                {
                    "name":"RolloverQuestionAnswer",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Yes"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
            }
        }
    },
    "description":"Advanced property associated with a form item.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "type":"RolloverQuestion",
        "name":"RolloverQuestionStudyId",
        "value":"C2C8327AFAA6412287106192AB5984EF",
        "label":"Rollover Study BT-31",
        "rules":[
            {
                "name":"RolloverQuestionAnswer",
                "value":"YES",
                "label":"Yes"
            }
        ]
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "type":"RolloverQuestion",
    "name":"RolloverQuestionStudyId",
    "value":"C2C8327AFAA6412287106192AB5984EF",
    "label":"Rollover Study BT-31",
    "rules":[
        {
            "name":"RolloverQuestionAnswer",
            "value":"YES",
            "label":"Yes"
        }
    ]
}

Nested Schema : rules

Type: array

Advanced property rules list.

Show Source

• Array of: object FormItemAdvancedPropRuleDto v21.0
  Title: FormItemAdvancedPropRuleDto v21.0

  Rule entry for a form item advanced property.

{
    "type":"array",
    "description":"Advanced property rules list.",
    "example":[
        {
            "name":"RolloverQuestionAnswer",
            "value":"B1B8327AFAA6412287106192AB5984EF",
            "label":"Yes"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
    }
}

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

• label: string
  Rule label.

  Example: Yes
• name: string
  Rule name.

  Example: RolloverQuestionAnswer
• value: string
  Rule value.

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"FormItemAdvancedPropRuleDto v21.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Rule name.",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"Rule value.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rule label.",
            "example":"Yes"
        }
    },
    "description":"Rule entry for a form item advanced property.",
    "example":{
        "name":"RolloverQuestionAnswer",
        "value":"YES",
        "label":"Yes"
    }
}

Example:

{
    "name":"RolloverQuestionAnswer",
    "value":"YES",
    "label":"Yes"
}

Nested Schema : FormNumberItemDto v21.0-allOf[1]

Type: object

Show Source

• precision: integer (int32)
  Minimum Value: 0

  Number of digits allowed after the decimal point. Minimum value: 0.

  Example: 1
• units: string
  Unit of measure displayed with the numeric answer when configured.

  Example: kg

{
    "type":"object",
    "properties":{
        "precision":{
            "minimum":0,
            "type":"integer",
            "description":"Number of digits allowed after the decimal point. Minimum value: 0.",
            "format":"int32",
            "example":1
        },
        "units":{
            "type":"string",
            "description":"Unit of measure displayed with the numeric answer when configured.",
            "example":"kg"
        }
    }
}

Nested Schema : FormChoiceItemDto v21.0-allOf[1]

Type: object

Show Source

• advancedProps: array advancedProps
• clDescription: string
  Minimum Length: 0

  Maximum Length: 4000

  Codelist description only for choice type formitem

  Example: Standard gender codelist
• clTitle: string
  Codelist title only for choice type formitem

  Example: Gender
• codelistId: string (uuid)
  ID of the codelist used by the choice item (UUID, 32-character uppercase hexadecimal string).
• codelistLang: string
  Language of the codelist used by the choice item.

  Example: en-US
• codelistLinkType: string
  Allowed Values: [ "STATIC", "DYNAMIC" ]

  Indicates whether the codelist mapped to the item is static or dynamic.

  Example: STATIC
• columnLayout: string
  Column layout codelist ID (UUID, 32-character uppercase hexadecimal string).

  Example: EBCF17C5F8D4460AA4A9673485C79CF0
• columnLayoutLabel: string
  Column layout label displayed for the choice item.

  Example: Single
• display: string
  Pattern: selectbox|checkbox|radioset|label

  Display control used for the choice item. Allowed values: selectbox, checkbox, radioset, or label.

  Example: radioset
• isCodeListReplaced: boolean
  Indicates if the choice option codelist is replaced

  Example: true
• options: array options

{
    "type":"object",
    "properties":{
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
            }
        },
        "display":{
            "pattern":"selectbox|checkbox|radioset|label",
            "type":"string",
            "description":"Display control used for the choice item. Allowed values: selectbox, checkbox, radioset, or label.",
            "example":"radioset"
        },
        "columnLayout":{
            "type":"string",
            "description":"Column layout codelist ID (UUID, 32-character uppercase hexadecimal string).",
            "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
        },
        "columnLayoutLabel":{
            "type":"string",
            "description":"Column layout label displayed for the choice item.",
            "example":"Single"
        },
        "options":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormOptionDtov21"
            }
        },
        "clTitle":{
            "type":"string",
            "description":"Codelist title only for choice type formitem",
            "example":"Gender"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Codelist description only for choice type formitem",
            "example":"Standard gender codelist"
        },
        "isCodeListReplaced":{
            "type":"boolean",
            "description":"Indicates if the choice option codelist is replaced",
            "example":true
        },
        "codelistLinkType":{
            "type":"string",
            "description":"Indicates whether the codelist mapped to the item is static or dynamic.",
            "example":"STATIC",
            "enum":[
                "STATIC",
                "DYNAMIC"
            ]
        },
        "codelistId":{
            "type":"string",
            "description":"ID of the codelist used by the choice item (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "codelistLang":{
            "type":"string",
            "description":"Language of the codelist used by the choice item.",
            "example":"en-US"
        }
    }
}

Nested Schema : advancedProps

Type: array

Show Source

• Array of: object FormItemAdvancedPropWithParentDto v21.0
  Title: FormItemAdvancedPropWithParentDto v21.0

  Advanced property associated with a form item and its parent object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
    }
}

Nested Schema : options

Type: array

Show Source

• Array of: object FormOptionDto v21.0
  Title: FormOptionDto v21.0

  Selectable option returned for a choice form item.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormOptionDtov21"
    }
}

Nested Schema : FormItemAdvancedPropWithParentDto v21.0

Type: object

Title: FormItemAdvancedPropWithParentDto v21.0

Advanced property associated with a form item and its parent object.

Show Source

• id: string (uuid)
  Extended property ID (UUID, 32-character uppercase hexadecimal string).
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name: string
  Advanced property name

  Example: RolloverQuestionStudyId
• parentObjectId: string (uuid)
  Parent object ID (UUID, 32-character uppercase hexadecimal string).
• parentObjectLabel: string
  Parent object label.

  Example: Demographics
• parentObjectLevel: string
  Parent object level.

  Example: FORM
• rules: array rules
  Advanced property rules list.
• type: string
  Advanced property type.

  Example: RolloverQuestion
• value: string
  Advanced property value. The meaning depends on the advanced property name.

  Example: C2C8327AFAA6412287106192AB5984EF

{
    "title":"FormItemAdvancedPropWithParentDto v21.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended property ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Advanced property type.",
            "example":"RolloverQuestion"
        },
        "name":{
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "type":"string",
            "description":"Advanced property value. The meaning depends on the advanced property name.",
            "example":"C2C8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "description":"Advanced property rules list.",
            "example":[
                {
                    "name":"RolloverQuestionAnswer",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Yes"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
            }
        },
        "parentObjectId":{
            "type":"string",
            "description":"Parent object ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "parentObjectLabel":{
            "type":"string",
            "description":"Parent object label.",
            "example":"Demographics"
        },
        "parentObjectLevel":{
            "type":"string",
            "description":"Parent object level.",
            "example":"FORM"
        }
    },
    "description":"Advanced property associated with a form item and its parent object.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "type":"AssignedVisit",
        "name":"Visit",
        "value":"D3D8327AFAA6412287106192AB5984EF",
        "label":"Screening",
        "parentObjectId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "parentObjectLabel":"Demographics",
        "parentObjectLevel":"FORM"
    }
}

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

• Array of: object FormItemAdvancedPropRuleDto v21.0
  Title: FormItemAdvancedPropRuleDto v21.0

  Rule entry for a form item advanced property.

{
    "type":"array",
    "description":"Advanced property rules list.",
    "example":[
        {
            "name":"RolloverQuestionAnswer",
            "value":"B1B8327AFAA6412287106192AB5984EF",
            "label":"Yes"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
    }
}

Example:

[
    {
        "name":"RolloverQuestionAnswer",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Yes"
    }
]

Nested Schema : FormOptionDto v21.0

Type: object

Title: FormOptionDto v21.0

Selectable option returned for a choice form item.

Show Source

• clCode: string
  Codelist code for the choice option when linked to a codelist.

  Example: F
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description for the choice option when linked to a codelist.

  Example: Female
• clItemId: string (uuid)
  Codelist item ID for the choice option (UUID, 32-character uppercase hexadecimal string).
• clValue: string
  Codelist value for the choice option when linked to a codelist.

  Example: Female
• hidden: boolean
  Is form item option hidden?

  Example: false
• label: string
  Minimum Length: 1

  Maximum Length: 4000

  Display label for the choice option.

  Example: Female
• optionSeq: string
  Minimum Length: 1

  Maximum Length: 4000

  Sequence value for ordering the choice option.

  Example: 1
• value: string
  Minimum Length: 1

  Maximum Length: 4000

  Stored answer value for the choice option.

  Example: F

{
    "title":"FormOptionDto v21.0",
    "type":"object",
    "properties":{
        "label":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Display label for the choice option.",
            "example":"Female"
        },
        "value":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Stored answer value for the choice option.",
            "example":"F"
        },
        "clCode":{
            "type":"string",
            "description":"Codelist code for the choice option when linked to a codelist.",
            "example":"F"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Codelist description for the choice option when linked to a codelist.",
            "example":"Female"
        },
        "clValue":{
            "type":"string",
            "description":"Codelist value for the choice option when linked to a codelist.",
            "example":"Female"
        },
        "clItemId":{
            "type":"string",
            "description":"Codelist item ID for the choice option (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item option hidden?",
            "example":false
        },
        "optionSeq":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Sequence value for ordering the choice option.",
            "example":"1"
        }
    },
    "description":"Selectable option returned for a choice form item.",
    "example":{
        "label":"Female",
        "value":"F",
        "clCode":"F",
        "clDescription":"Female",
        "clValue":"Female",
        "clItemId":"1F4A6C7E1B8F4D56A23C9F3A0C7D4E21",
        "hidden":false,
        "optionSeq":"1"
    }
}

Example:

{
    "label":"Female",
    "value":"F",
    "clCode":"F",
    "clDescription":"Female",
    "clValue":"Female",
    "clItemId":"1F4A6C7E1B8F4D56A23C9F3A0C7D4E21",
    "hidden":false,
    "optionSeq":"1"
}

Nested Schema : FormTextItemDto v21.0-allOf[1]

Type: object

Show Source

• maxlength: integer (int32)
  Minimum Value: 0

  Maximum Value: 4000

  Maximum number of characters allowed for the text answer. Allowed range: 0 to 4000.

  Example: 4000
• multiline: boolean
  Indicates whether the text answer supports multiple lines.

  Example: false

{
    "type":"object",
    "properties":{
        "maxlength":{
            "maximum":4000,
            "minimum":0,
            "type":"integer",
            "description":"Maximum number of characters allowed for the text answer. Allowed range: 0 to 4000.",
            "format":"int32",
            "example":4000
        },
        "multiline":{
            "type":"boolean",
            "description":"Indicates whether the text answer supports multiple lines.",
            "example":false
        }
    }
}

Nested Schema : FormDatetimeItemDto v21.0-allOf[1]

Type: object

Show Source

• allowFutureDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Indicates whether future dates are allowed. Allowed values: 0 or 1.

  Example: 0
• allowPartialDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Indicates whether partial dates are allowed. Allowed values: 0 or 1.

  Example: 1
• format: string
  Date or date-time display format for the answer.

  Example: DD-MON-YYYY
• partialDate: string
  Partial date format returned when partial dates are allowed.

  Example: MON-YYYY

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string",
            "description":"Date or date-time display format for the answer.",
            "example":"DD-MON-YYYY"
        },
        "allowPartialDate":{
            "maximum":1,
            "minimum":0,
            "type":"integer",
            "description":"Indicates whether partial dates are allowed. Allowed values: 0 or 1.",
            "format":"int32",
            "example":1
        },
        "partialDate":{
            "type":"string",
            "description":"Partial date format returned when partial dates are allowed.",
            "example":"MON-YYYY"
        },
        "allowFutureDate":{
            "maximum":1,
            "minimum":0,
            "type":"integer",
            "description":"Indicates whether future dates are allowed. Allowed values: 0 or 1.",
            "format":"int32",
            "example":0
        }
    }
}

Nested Schema : FormQuestionGroupItemDto v21.0-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtov21"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemDtov21"
    }
}

Nested Schema : FormTableItemDto v21.0-allOf[1]

Type: object

Show Source

• allowAdditionalRows: boolean
• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtov21"
            }
        },
        "allowAdditionalRows":{
            "type":"boolean"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemDtov21"
    }
}

Nested Schema : FormItemDto v16.0

Type: object

Title: FormItemDto v16.0

Discriminator: questionType

Discriminator Values

• datetime
• numeric
• measurement
• text
• choice
• questionGroup
• table
• label

{
    "title":"FormItemDto v16.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"How many leading questions in this form have to be answered by user correctly before Item is included into the form.",
            "format":"int32",
            "example":1
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32"
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item Unique GUID",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov16"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov16"
            }
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        }
    },
    "description":"Form Item Information",
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        }
    ]
}

Form Item Information

Show Source

• advancedProps: array advancedProps
• applyChangeToVersion: string
  For IPR apply change to version

  Example: 1.0.0.1
• clLabNormalsTag: string
  Code list Lab Normals Tag used in the code list dialog tagging

  Example: LabTest, LabUnit, LabGender, LabRace, LabStandardResult
• dataClassificationIds: array dataClassificationIds
• dataClassificationLevel: string
  Data classification level if applicable

  Example: edit, view
• dynamic: integer (int32)
  How many leading questions in this form have to be answered by user correctly before Item is included into the form.

  Example: 1
• formId: string (uuid)
  Form Unique GUID
• formTitle: string
  Form title

  Example: Demography
• formula: string
  Smart item formula.

  Example: [{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]
• groupSequence: integer (int32)
  Group sequence.
• hidden: boolean
  Is form item hidden?

  Example: false
• id: string (uuid)
  Form Item Unique GUID
• isCohortFactor: boolean
  Flag that indicates whether this form item is used as a factor for randomization cohort or not.

  Example: false
• isStrataFactor: boolean
  Flag that indicates whether this form item is used as a factor for randomization stratum or not.

  Example: false
• labNormalsTag: string
  Lab Normals Tag used in dialog tagging

  Example: LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult
• questionHint: string
  Minimum Length: 0

  Maximum Length: 4000

  Form question hint

  Example: What is your age?
• questionLabel(required): string
  Minimum Length: 1

  Maximum Length: 4000

  Form question label

  Example: Age
• questionType(required): string
  Title: FormItemType

  Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]

  Question type

  Example: numeric
• randomizationTag: boolean
  Flag that indicates whether this form item should be used for randomization stratification or not.

  Example: true
• readOnly: boolean
  Is form item read only?

  Example: false
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form item reference name.

  Example: NUMBER_01
• required(required): boolean
  Whether this form item is requiered or not.

  Example: true
• ruleSet: string
  A JSON-formatted set of rules to do validation of the answers.

  Example: {'logicalOperator':'NONE','rules':[],'numberIndex':1}
• sasLabel: string
  Form Item sasLabel

  Example: Adverse Event
• sasVariable: string
  Form Item SASVariable

  Example: AE
• sdvRequired(required): string
  Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]

  Source Data Verification Type

  Example: NEVER(0),ALWAYS(1),CRITICAL(2)
• sequence: integer (int32)
  Item position in the form.

  Example: 1
• smartItemId: string (uuid)
  Smart item Unique GUID
• smartObject: string
  Smart object.

  Example: AGE

{
    "title":"FormItemDto v16.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"How many leading questions in this form have to be answered by user correctly before Item is included into the form.",
            "format":"int32",
            "example":1
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32"
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item Unique GUID",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov16"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov16"
            }
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        }
    },
    "description":"Form Item Information",
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        }
    ]
}

Match One Schema

Show Source

• object FormNumberItemDto v16.0
  Title: FormNumberItemDto v16.0

  Form Number Item Details Information
• object FormChoiceItemDto v16.0
  Title: FormChoiceItemDto v16.0

  Form Choice Item Details Information
• object FormTextItemDto v16.0
  Title: FormTextItemDto v16.0

  Form text Item Details Information
• object FormDatetimeItemDto v16.0
  Title: FormDatetimeItemDto v16.0

  Form DateTime Item Details Information
• object FormQuestionGroupItemDto v16.0
  Title: FormQuestionGroupItemDto v16.0

  Form Question Group Item Details Information
• object FormTableItemDto v16.0
  Title: FormTableItemDto v16.0

  Form table Item Details Information
• object FormLabelItemDto

{
    "title":"FormItemDto v16.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"How many leading questions in this form have to be answered by user correctly before Item is included into the form.",
            "format":"int32",
            "example":1
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32"
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item Unique GUID",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov16"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov16"
            }
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        }
    },
    "description":"Form Item Information",
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov16"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        }
    ]
}

Nested Schema : FormLabelItemDto-allOf[1]

Type: object

Show Source

• advancedProps: array advancedProps
• clDescription: string
  Minimum Length: 0

  Maximum Length: 4000

  Codelist description only for choice type formitem

  Example: Standard gender codelist
• clTitle: string
  Codelist title only for choice type formitem

  Example: Gender
• columnLayout: string
  Coumn Layout codelist ID

  Example: EBCF17C5F8D4460AA4A9673485C79CF0
• columnLayoutLabel: string
  Coumn Layout Label in UI

  Example: Single
• display: string
  Pattern: selectbox|checkbox|radioset|label

  Form choice item display in UI - Selectbox.

  Example: selectbox
• isCodeListReplaced: boolean
  Indicates if the choice option codelist is replaced

  Example: true
• options: array options

{
    "type":"object",
    "properties":{
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov16"
            }
        },
        "display":{
            "pattern":"selectbox|checkbox|radioset|label",
            "type":"string",
            "description":"Form choice item display in UI - Selectbox.",
            "example":"selectbox"
        },
        "columnLayout":{
            "type":"string",
            "description":"Coumn Layout codelist ID",
            "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
        },
        "columnLayoutLabel":{
            "type":"string",
            "description":"Coumn Layout Label in UI",
            "example":"Single"
        },
        "options":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormOptionDtov16"
            }
        },
        "clTitle":{
            "type":"string",
            "description":"Codelist title only for choice type formitem",
            "example":"Gender"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Codelist description only for choice type formitem",
            "example":"Standard gender codelist"
        },
        "isCodeListReplaced":{
            "type":"boolean",
            "description":"Indicates if the choice option codelist is replaced",
            "example":true
        }
    }
}

Nested Schema : advancedProps

Type: array

Show Source

• Array of: object From Item Advanced Property With Parent v16.0
  Title: From Item Advanced Property With Parent v16.0

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov16"
    }
}

Nested Schema : options

Type: array

Show Source

• Array of: object FormOptionDto v16.0
  Title: FormOptionDto v16.0

  Form choice item option details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormOptionDtov16"
    }
}

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

• id: string (uuid)
  Extended Property ID
• label: string (uuid)
  parent object ID
• name: string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• parentObjectLabel: string
  parent object name

  Example: Form 1
• parentObjectLevel: string
  type of parent object

  Example: FORM
• rules: array rules
• value: string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property With Parent v16.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"parent object ID",
            "format":"uuid"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov16"
            }
        },
        "parentObjectLabel":{
            "type":"string",
            "description":"parent object name",
            "example":"Form 1"
        },
        "parentObjectLevel":{
            "type":"string",
            "description":"type of parent object",
            "example":"FORM"
        }
    },
    "description":"Form Item Advanced Property with Parent Info"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v16.0
  Title: From Item Advanced Property Rule v16.0

  Form Item Advanced Property Rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov16"
    }
}

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

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v16.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : FormOptionDto v16.0

Type: object

Title: FormOptionDto v16.0

Form choice item option details

Show Source

• clCode: string
  Codelist code for a one specific choice.

  Example: 1
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description for a one specific choice.

  Example: 1
• clValue: string
  Codelist value for a one specific choice.

  Example: 1
• label: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox label for a one specific choice.

  Example: Female
• value: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox value for a one specific choice.

  Example: 1

{
    "title":"FormOptionDto v16.0",
    "type":"object",
    "properties":{
        "label":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form choice selectbox label for a one specific choice.",
            "example":"Female"
        },
        "value":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form choice selectbox value for a one specific choice.",
            "example":"1"
        },
        "clCode":{
            "type":"string",
            "description":"Codelist code for a one specific choice.",
            "example":"1"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Codelist description for a one specific choice.",
            "example":"1"
        },
        "clValue":{
            "type":"string",
            "description":"Codelist value for a one specific choice.",
            "example":"1"
        }
    },
    "description":"Form choice item option details"
}

Nested Schema : FormInstructionalTextItemDto v21.0-allOf[1]

Type: object

Show Source

• instructionalText: string
  Instructional text displayed with the form item.

  Example: Please complete all required demographic questions.

{
    "type":"object",
    "properties":{
        "instructionalText":{
            "type":"string",
            "description":"Instructional text displayed with the form item.",
            "example":"Please complete all required demographic questions."
        }
    }
}

Nested Schema : FormExistingDataItemDto v21.0-allOf[1]

Type: object

Show Source

• existingDataCodeName: string
  Existing-data codelist name. The value must come from the ExistingDataLabels codelist.

  Example: EDLSite
• existingDataCodeValue: string
  Existing-data codelist value. The value must come from the codelist identified by existingDataCodeName.

  Example: SiteName

{
    "type":"object",
    "properties":{
        "existingDataCodeName":{
            "type":"string",
            "description":"Existing-data codelist name. The value must come from the ExistingDataLabels codelist.",
            "example":"EDLSite"
        },
        "existingDataCodeValue":{
            "type":"string",
            "description":"Existing-data codelist value. The value must come from the codelist identified by existingDataCodeName.",
            "example":"SiteName"
        }
    }
}

Examples

Select an example Form items response

400 Response

The request contains an invalid study ID, form ID, mode, or item type filter.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example badRequest

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

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example serverError

Back to Top