Jump to

• Request
• Response

Get list of latest forms by mode in a study

get

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/latest

Retrieves all forms in a study for a latest study version based on mode.

Request

Path Parameters

• mode(required): string
  Study mode to filter study forms.

  Allowed Values: [ "test", "training", "active" ]
• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"

Query Parameters

• excludeItemType: string
  Form Item type to exclude from response

  Allowed Values: [ "instructionalText" ]
• formCategory: string
  Return forms with this Form Category.

  Default Value: DCS
• items: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormDtoWithStudyVersion

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

Nested Schema : FormDtoWithStudyVersion

Type: object

Show Source

• allowMultipleInstances: boolean
  Allow multiple instances

  Example: true
• assignedVisits: array assignedVisits
  branch cycle information describing the visits on which the forms are displayed
• baseStudyVersion: string
  Base Study version of the study from which the form is requested.

  Example: 1.0.0.1
• dynamic: integer (int32)
  Count of forms items that point to this form for Show Form feature

  Example: 4
• formCategory: string
  Form category

  Example: DCS
• formSubcategory: array formSubcategory
  Form subcategory list
• formType: string
  Allowed Values: [ "STANDARD_FORM", "LAB_FORM", "TWO_SECTION_FORM", "DRUG_RECONCILIATION_FORM", "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM" ]

  Form type

  Example: STANDARD_FORM
• hasRevision: boolean
  Indicate whether any revisions from a newer study version have been applied

  Example: true
• id: string (uuid)
  Form Unique GUID
• includeInSafetyCaseData: boolean
  Is form associated to Safety Case Forms

  Example: true
• items: array items
• linkFrom: array linkFrom
  linked from forms
• logoFileName: string
  Logo File Name
• logoFileUploadRequest: object FileUploadRequest
  Logo uploaded to fileupload service response name
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form refname

  Example: FORM_01
• repeat: boolean
  Form repeating?

  Example: false
• showFrom: array showFrom
  show dynamic parent from forms of same visit
• source: object FormCopySourceDto v17.0
  Title: FormCopySourceDto v17.0

  Form Copy Source Information
• studyVersion: string
  Study version of the study in which form belongs

  Example: 1.0.0.1
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form title

  Example: Demography
• versionStart: string (date-time)
  The form's version date

{
    "required":[
        "refname",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "refname":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "repeat":{
            "type":"boolean",
            "description":"Form repeating?",
            "example":false
        },
        "source":{
            "$ref":"#/components/schemas/FormCopySourceDtov17"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtov17"
            }
        },
        "versionStart":{
            "type":"string",
            "description":"The form's version date",
            "format":"date-time"
        },
        "allowMultipleInstances":{
            "type":"boolean",
            "description":"Allow multiple instances",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"Count of forms items that point to this form for Show Form feature",
            "format":"int32",
            "example":"4"
        },
        "formType":{
            "type":"string",
            "description":"Form type",
            "example":"STANDARD_FORM",
            "enum":[
                "STANDARD_FORM",
                "LAB_FORM",
                "TWO_SECTION_FORM",
                "DRUG_RECONCILIATION_FORM",
                "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM"
            ]
        },
        "hasRevision":{
            "type":"boolean",
            "description":"Indicate whether any revisions from a newer study version have been applied",
            "example":true
        },
        "linkFrom":{
            "type":"array",
            "description":"linked from forms",
            "items":{
                "$ref":"#/components/schemas/FormLinkFromDtov17"
            }
        },
        "showFrom":{
            "type":"array",
            "description":"show dynamic parent from forms of same visit",
            "items":{
                "$ref":"#/components/schemas/FormLinkFromDtov17"
            }
        },
        "assignedVisits":{
            "type":"array",
            "description":"branch cycle information describing the visits on which the forms are displayed",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
            }
        },
        "includeInSafetyCaseData":{
            "type":"boolean",
            "description":"Is form associated to Safety Case Forms",
            "example":true
        },
        "formCategory":{
            "type":"string",
            "description":"Form category",
            "example":"DCS"
        },
        "formSubcategory":{
            "type":"array",
            "description":"Form subcategory list",
            "items":{
                "type":"string",
                "description":"Form subcategory list"
            }
        },
        "logoFileName":{
            "type":"string",
            "description":"Logo File Name"
        },
        "logoFileUploadRequest":{
            "$ref":"#/components/schemas/FileUploadRequest"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version of the study in which form belongs",
            "example":"1.0.0.1"
        },
        "baseStudyVersion":{
            "type":"string",
            "description":"Base Study version of the study from which the form is requested.",
            "example":"1.0.0.1"
        }
    }
}

Nested Schema : assignedVisits

Type: array

branch cycle information describing the visits on which the forms are displayed

Show Source

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

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "description":"branch cycle information describing the visits on which the forms are displayed",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
    }
}

Nested Schema : formSubcategory

Type: array

Form subcategory list

Show Source

• Array of: string
  Form subcategory list

{
    "type":"array",
    "description":"Form subcategory list",
    "items":{
        "type":"string",
        "description":"Form subcategory list"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information

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

Nested Schema : linkFrom

Type: array

linked from forms

Show Source

• Array of: object FormLinkFromDto v17.0
  Title: FormLinkFromDto v17.0

  Linked From Form Details

{
    "type":"array",
    "description":"linked from forms",
    "items":{
        "$ref":"#/components/schemas/FormLinkFromDtov17"
    }
}

Nested Schema : FileUploadRequest

Type: object

Logo uploaded to fileupload service response name

Show Source

• contentType: string
  File Content-Type
• fileName(required): string
  File name

  Example: File1001
• mode(required): string
  Mode of the study, accepts: test, active, or training

  Example: test, active, or training
• name(required): string
  Random name for bucket where file uploaded

  Example: 1A73BC4FE4954AE4AC50DDF9729F80BE

{
    "required":[
        "fileName",
        "mode",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Random name for bucket where file uploaded",
            "example":"1A73BC4FE4954AE4AC50DDF9729F80BE"
        },
        "mode":{
            "type":"string",
            "description":"Mode of the study, accepts: test, active, or training",
            "example":"test, active, or training"
        },
        "fileName":{
            "type":"string",
            "description":"File name",
            "example":"File1001"
        },
        "contentType":{
            "type":"string",
            "description":"File Content-Type"
        }
    },
    "description":"Logo uploaded to fileupload service response name"
}

Nested Schema : showFrom

Type: array

show dynamic parent from forms of same visit

Show Source

• Array of: object FormLinkFromDto v17.0
  Title: FormLinkFromDto v17.0

  Linked From Form Details

{
    "type":"array",
    "description":"show dynamic parent from forms of same visit",
    "items":{
        "$ref":"#/components/schemas/FormLinkFromDtov17"
    }
}

Nested Schema : FormCopySourceDto v17.0

Type: object

Title: FormCopySourceDto v17.0

Form Copy Source Information

Show Source

• FormId: string (uuid)
  Source Form GUID
• id: string (uuid)
  Source Study GUID
• StudyTitle: string
  Source Study title

  Example: Study-s1
• versionstart: boolean
  is Rules Copied

  Example: false

{
    "title":"FormCopySourceDto v17.0",
    "type":"object",
    "properties":{
        "FormId":{
            "type":"string",
            "description":"Source Form GUID",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "description":"Source Study GUID",
            "format":"uuid"
        },
        "StudyTitle":{
            "type":"string",
            "description":"Source Study title",
            "example":"Study-s1"
        },
        "versionstart":{
            "type":"boolean",
            "description":"is Rules Copied",
            "example":false
        }
    },
    "description":"Form Copy Source Information"
}

Nested Schema : From Item Advanced Property With Parent v17.0

Type: object

Title: From Item Advanced Property With Parent v17.0

Form Item Advanced Property with Parent Info

Show Source

• 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 v17.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/FormItemAdvancedPropRuleDtov17"
            }
        },
        "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 v17.0
  Title: From Item Advanced Property Rule v17.0

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v17.0

Type: object

Title: From Item Advanced Property Rule v17.0

Form Item Advanced Property Rule

Show Source

• 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 v17.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 : FormItemDto v17.0

Type: object

Title: FormItemDto v17.0

Discriminator: questionType

Discriminator Values

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

{
    "title":"FormItemDto v17.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"
            ]
        },
        "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/FormItemAdvancedPropDtov17"
            }
        },
        "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/FormItemAdvancedPropDtov17"
            }
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov17",
            "numeric":"#/components/schemas/FormNumberItemDtov17",
            "measurement":"#/components/schemas/FormNumberItemDtov17",
            "text":"#/components/schemas/FormTextItemDtov17",
            "choice":"#/components/schemas/FormChoiceItemDtov17",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17",
            "table":"#/components/schemas/FormTableItemDtov17",
            "section":"#/components/schemas/FormSectionalItemDtov17",
            "label":"#/components/schemas/FormInstructionalTextItemDtov17",
            "existingData":"#/components/schemas/Form existing data item DTO"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov17"
        },
        {
            "$ref":"#/components/schemas/Form existing data item DTO"
        }
    ]
}

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" ]

  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 v17.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"
            ]
        },
        "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/FormItemAdvancedPropDtov17"
            }
        },
        "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/FormItemAdvancedPropDtov17"
            }
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov17",
            "numeric":"#/components/schemas/FormNumberItemDtov17",
            "measurement":"#/components/schemas/FormNumberItemDtov17",
            "text":"#/components/schemas/FormTextItemDtov17",
            "choice":"#/components/schemas/FormChoiceItemDtov17",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17",
            "table":"#/components/schemas/FormTableItemDtov17",
            "section":"#/components/schemas/FormSectionalItemDtov17",
            "label":"#/components/schemas/FormInstructionalTextItemDtov17",
            "existingData":"#/components/schemas/Form existing data item DTO"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov17"
        },
        {
            "$ref":"#/components/schemas/Form existing data item DTO"
        }
    ]
}

Match One Schema

Show Source

• object FormNumberItemDto v17.0
  Title: FormNumberItemDto v17.0

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

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

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

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

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

  Form table Item Details Information
• object FormSectionalItemDto v17.0
  Title: FormSectionalItemDto v17.0

  Form Section Item Details Information
• object FormLabelItemDto
• object FormInstructionalTextItem v17.0
  Title: FormInstructionalTextItem v17.0

  Instructional information about the form or question
• object Form existing data item DTO
  Form existing data item Information

{
    "title":"FormItemDto v17.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"
            ]
        },
        "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/FormItemAdvancedPropDtov17"
            }
        },
        "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/FormItemAdvancedPropDtov17"
            }
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov17",
            "numeric":"#/components/schemas/FormNumberItemDtov17",
            "measurement":"#/components/schemas/FormNumberItemDtov17",
            "text":"#/components/schemas/FormTextItemDtov17",
            "choice":"#/components/schemas/FormChoiceItemDtov17",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17",
            "table":"#/components/schemas/FormTableItemDtov17",
            "section":"#/components/schemas/FormSectionalItemDtov17",
            "label":"#/components/schemas/FormInstructionalTextItemDtov17",
            "existingData":"#/components/schemas/Form existing data item DTO"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov17"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov17"
        },
        {
            "$ref":"#/components/schemas/Form existing data item DTO"
        }
    ]
}

Nested Schema : advancedProps

Type: array

Show Source

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

  Form Item Advanced Property

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

Nested Schema : dataClassificationIds

Type: array

Show Source

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

  Form Item Advanced Property

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

Nested Schema : FormNumberItemDto v17.0

Type: object

Title: FormNumberItemDto v17.0

Form Number Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormNumberItemDto v17.0-allOf[1]

{
    "title":"FormNumberItemDto v17.0",
    "required":[
        "precision",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Number Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "precision":{
                    "minimum":"0",
                    "type":"integer",
                    "description":"Number value precision",
                    "format":"int32",
                    "example":"1"
                },
                "units":{
                    "type":"string",
                    "description":"Units of measure",
                    "example":"kg"
                }
            }
        }
    ]
}

Nested Schema : FormChoiceItemDto v17.0

Type: object

Title: FormChoiceItemDto v17.0

Form Choice Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormChoiceItemDto v17.0-allOf[1]

{
    "title":"FormChoiceItemDto v17.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Choice Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "advancedProps":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
                    }
                },
                "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/FormOptionDtov17"
                    }
                },
                "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 : FormTextItemDto v17.0

Type: object

Title: FormTextItemDto v17.0

Form text Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormTextItemDto v17.0-allOf[1]

{
    "title":"FormTextItemDto v17.0",
    "required":[
        "maxlength",
        "multiline",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form text Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "maxlength":{
                    "maximum":"4000",
                    "minimum":"0",
                    "type":"integer",
                    "description":"Form text item max length",
                    "format":"int32",
                    "example":"4000"
                },
                "multiline":{
                    "type":"boolean",
                    "description":"Is form text item multiline",
                    "example":false
                }
            }
        }
    ]
}

Nested Schema : FormDatetimeItemDto v17.0

Type: object

Title: FormDatetimeItemDto v17.0

Form DateTime Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormDatetimeItemDto v17.0-allOf[1]

{
    "title":"FormDatetimeItemDto v17.0",
    "required":[
        "format",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form DateTime Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "format":{
                    "type":"string",
                    "description":"Date time format",
                    "example":"DD-MON-YYYY"
                },
                "allowPartialDate":{
                    "maximum":"1",
                    "minimum":"0",
                    "type":"integer",
                    "description":"Allow partial date",
                    "format":"int32",
                    "example":"1"
                },
                "partialDate":{
                    "type":"string",
                    "description":"Partial date format",
                    "example":"Jan-1993"
                },
                "allowFutureDate":{
                    "maximum":"1",
                    "minimum":"0",
                    "type":"integer",
                    "description":"Allow future date",
                    "format":"int32",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : FormQuestionGroupItemDto v17.0

Type: object

Title: FormQuestionGroupItemDto v17.0

Form Question Group Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information

{
    "title":"FormQuestionGroupItemDto v17.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Question Group Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        }
    ]
}

Nested Schema : FormTableItemDto v17.0

Type: object

Title: FormTableItemDto v17.0

Form table Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormTableItemDto v17.0-allOf[1]

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

Nested Schema : FormSectionalItemDto v17.0

Type: object

Title: FormSectionalItemDto v17.0

Form Section Item Details Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information

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

Nested Schema : FormLabelItemDto

Type: object

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormLabelItemDto-allOf[1]

{
    "required":[
        "display",
        "options",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "advancedProps":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
                    }
                },
                "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/FormOptionDtov17"
                    }
                },
                "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 : FormInstructionalTextItem v17.0

Type: object

Title: FormInstructionalTextItem v17.0

Instructional information about the form or question

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object FormInstructionalTextItem v17.0-allOf[1]

{
    "title":"FormInstructionalTextItem v17.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Instructional information about the form or question",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "instructionalText":{
                    "type":"string",
                    "description":"Instructional information about the form or question",
                    "example":"Complete all parts of the form"
                }
            }
        }
    ]
}

Nested Schema : Form existing data item DTO

Type: object

Form existing data item Information

Match All

Show Source

• object FormItemDto v17.0
  Title: FormItemDto v17.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov17", "numeric":"#/components/schemas/FormNumberItemDtov17", "measurement":"#/components/schemas/FormNumberItemDtov17", "text":"#/components/schemas/FormTextItemDtov17", "choice":"#/components/schemas/FormChoiceItemDtov17", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov17", "table":"#/components/schemas/FormTableItemDtov17", "section":"#/components/schemas/FormSectionalItemDtov17", "label":"#/components/schemas/FormInstructionalTextItemDtov17", "existingData":"#/components/schemas/Form existing data item DTO" } }

  Form Item Information
• object Form existing data item DTO-allOf[1]

{
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form existing data item Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov17"
        },
        {
            "type":"object",
            "properties":{
                "codeName":{
                    "type":"string",
                    "description":"Codelist name for existing data, must be a value from ExistingDataLabels codelist",
                    "example":"EDLSite"
                },
                "codeValue":{
                    "type":"string",
                    "description":"Codelist value specifying existing data, must be a value from codelist defined in codeName",
                    "example":"SiteName"
                }
            }
        }
    ]
}

Nested Schema : From Item Advanced Property v17.0

Type: object

Title: From Item Advanced Property v17.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name: string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• 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 v17.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":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov17"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

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

  Form Item Advanced Property Rule

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

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

Type: object

Show Source

• precision: integer (int32)
  Minimum Value: 0

  Number value precision

  Example: 1
• units: string
  Units of measure

  Example: kg

{
    "type":"object",
    "properties":{
        "precision":{
            "minimum":"0",
            "type":"integer",
            "description":"Number value precision",
            "format":"int32",
            "example":"1"
        },
        "units":{
            "type":"string",
            "description":"Units of measure",
            "example":"kg"
        }
    }
}

Nested Schema : FormChoiceItemDto v17.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
• 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/FormItemAdvancedPropWithParentDtov17"
            }
        },
        "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/FormOptionDtov17"
            }
        },
        "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 v17.0
  Title: From Item Advanced Property With Parent v17.0

  Form Item Advanced Property with Parent Info

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

Nested Schema : options

Type: array

Show Source

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

  Form choice item option details

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

Nested Schema : FormOptionDto v17.0

Type: object

Title: FormOptionDto v17.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 v17.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 : FormTextItemDto v17.0-allOf[1]

Type: object

Show Source

• maxlength: integer (int32)
  Minimum Value: 0

  Maximum Value: 4000

  Form text item max length

  Example: 4000
• multiline: boolean
  Is form text item multiline

  Example: false

{
    "type":"object",
    "properties":{
        "maxlength":{
            "maximum":"4000",
            "minimum":"0",
            "type":"integer",
            "description":"Form text item max length",
            "format":"int32",
            "example":"4000"
        },
        "multiline":{
            "type":"boolean",
            "description":"Is form text item multiline",
            "example":false
        }
    }
}

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

Type: object

Show Source

• allowFutureDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Allow future date

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

  Maximum Value: 1

  Allow partial date

  Example: 1
• format: string
  Date time format

  Example: DD-MON-YYYY
• partialDate: string
  Partial date format

  Example: Jan-1993

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string",
            "description":"Date time format",
            "example":"DD-MON-YYYY"
        },
        "allowPartialDate":{
            "maximum":"1",
            "minimum":"0",
            "type":"integer",
            "description":"Allow partial date",
            "format":"int32",
            "example":"1"
        },
        "partialDate":{
            "type":"string",
            "description":"Partial date format",
            "example":"Jan-1993"
        },
        "allowFutureDate":{
            "maximum":"1",
            "minimum":"0",
            "type":"integer",
            "description":"Allow future date",
            "format":"int32",
            "example":"1"
        }
    }
}

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

Type: object

Show Source

• allowAdditionalRows: boolean

{
    "type":"object",
    "properties":{
        "allowAdditionalRows":{
            "type":"boolean"
        }
    }
}

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/FormItemAdvancedPropWithParentDtov17"
            }
        },
        "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/FormOptionDtov17"
            }
        },
        "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 v17.0
  Title: From Item Advanced Property With Parent v17.0

  Form Item Advanced Property with Parent Info

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

Nested Schema : options

Type: array

Show Source

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

  Form choice item option details

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

Nested Schema : FormInstructionalTextItem v17.0-allOf[1]

Type: object

Show Source

• instructionalText: string
  Instructional information about the form or question

  Example: Complete all parts of the form

{
    "type":"object",
    "properties":{
        "instructionalText":{
            "type":"string",
            "description":"Instructional information about the form or question",
            "example":"Complete all parts of the form"
        }
    }
}

Nested Schema : Form existing data item DTO-allOf[1]

Type: object

Show Source

• codeName: string
  Codelist name for existing data, must be a value from ExistingDataLabels codelist

  Example: EDLSite
• codeValue: string
  Codelist value specifying existing data, must be a value from codelist defined in codeName

  Example: SiteName

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string",
            "description":"Codelist name for existing data, must be a value from ExistingDataLabels codelist",
            "example":"EDLSite"
        },
        "codeValue":{
            "type":"string",
            "description":"Codelist value specifying existing data, must be a value from codelist defined in codeName",
            "example":"SiteName"
        }
    }
}

Nested Schema : FormLinkFromDto v17.0

Type: object

Title: FormLinkFromDto v17.0

Linked From Form Details

Show Source

• formId: string (uuid)
  Form GUID
• items: array items
  Form items
• parentAssignedVisits: array parentAssignedVisits
  Parent Assigned Visits

{
    "title":"FormLinkFromDto v17.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "items":{
            "type":"array",
            "description":"Form items",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
            }
        },
        "parentAssignedVisits":{
            "type":"array",
            "description":"Parent Assigned Visits",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
            }
        }
    },
    "description":"Linked From Form Details"
}

Nested Schema : items

Type: array

Form items

Show Source

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

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "description":"Form items",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
    }
}

Nested Schema : parentAssignedVisits

Type: array

Parent Assigned Visits

Show Source

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

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "description":"Parent Assigned Visits",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov17"
    }
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top