Jump to

• Request
• Response

V2.0

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/visitsforms

Retrieves visits, forms, and questions for a study. When versions are supplied, the response is limited to those study versions. The optional excludeItemType query parameter can remove matching form item types from the questions list.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• excludeItemType: string
  Form item type to exclude from the question list. Optional. Allowed value: `instructionalText`.

  Allowed Values: [ "instructionalText" ]

  Example:

  instructionalText

• versions: string
  Comma-separated study version numbers used to filter visits, forms, and questions. Optional; when omitted, all study data returned by this endpoint is included.

  Example:

  1.0.0.1,1.0.0.2

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : VisitsFormsQuestionsDto

Type: object

Show Source

• forms: array forms
  Forms returned for the study. The endpoint returns form identifiers, titles, reference names, study versions, and version status.
• questions: array questions
  Questions from the returned forms. Each item includes its form reference, question metadata, and study version details.
• visits: array visits
  Visits returned for the study. Each visit includes its study version and status when available.

{
    "type":"object",
    "properties":{
        "visits":{
            "type":"array",
            "description":"Visits returned for the study. Each visit includes its study version and status when available.",
            "example":[
                {
                    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                    "title":"Screening",
                    "repeatVisit":false,
                    "repeatNumber":0,
                    "requiredVisit":true,
                    "eventType":"ScreeningVisit",
                    "shortName":"SCR",
                    "studyVersion":"1.0.0.1",
                    "studyVersionStatus":"TESTING"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDto"
            }
        },
        "forms":{
            "type":"array",
            "description":"Forms returned for the study. The endpoint returns form identifiers, titles, reference names, study versions, and version status.",
            "example":[
                {
                    "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
                    "title":"Demographics",
                    "refname":"DM",
                    "studyVersion":"1.0.0.1",
                    "studyVersionStatus":"TESTING"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormDto"
            }
        },
        "questions":{
            "type":"array",
            "description":"Questions from the returned forms. Each item includes its form reference, question metadata, and study version details.",
            "example":[
                {
                    "id":"6D3A9B2E5C1F4A77B22D5E9F1A8C3344",
                    "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
                    "formTitle":"Demographics",
                    "questionType":"TEXT",
                    "questionLabel":"Subject initials",
                    "refname":"INITIALS",
                    "required":true,
                    "sdvRequired":false,
                    "sequence":1,
                    "studyVersion":"1.0.0.1",
                    "studyVersionStatus":"TESTING"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemBasicDto"
            }
        }
    }
}

Nested Schema : forms

Type: array

Forms returned for the study. The endpoint returns form identifiers, titles, reference names, study versions, and version status.

Show Source

• Array of: object FormDto

{
    "type":"array",
    "description":"Forms returned for the study. The endpoint returns form identifiers, titles, reference names, study versions, and version status.",
    "example":[
        {
            "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
            "title":"Demographics",
            "refname":"DM",
            "studyVersion":"1.0.0.1",
            "studyVersionStatus":"TESTING"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormDto"
    }
}

Example:

[
    {
        "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "title":"Demographics",
        "refname":"DM",
        "studyVersion":"1.0.0.1",
        "studyVersionStatus":"TESTING"
    }
]

Nested Schema : questions

Type: array

Questions from the returned forms. Each item includes its form reference, question metadata, and study version details.

Show Source

• Array of: object FormItemBasicDto

{
    "type":"array",
    "description":"Questions from the returned forms. Each item includes its form reference, question metadata, and study version details.",
    "example":[
        {
            "id":"6D3A9B2E5C1F4A77B22D5E9F1A8C3344",
            "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
            "formTitle":"Demographics",
            "questionType":"TEXT",
            "questionLabel":"Subject initials",
            "refname":"INITIALS",
            "required":true,
            "sdvRequired":false,
            "sequence":1,
            "studyVersion":"1.0.0.1",
            "studyVersionStatus":"TESTING"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemBasicDto"
    }
}

Example:

[
    {
        "id":"6D3A9B2E5C1F4A77B22D5E9F1A8C3344",
        "formId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "formTitle":"Demographics",
        "questionType":"TEXT",
        "questionLabel":"Subject initials",
        "refname":"INITIALS",
        "required":true,
        "sdvRequired":false,
        "sequence":1,
        "studyVersion":"1.0.0.1",
        "studyVersionStatus":"TESTING"
    }
]

Nested Schema : visits

Type: array

Visits returned for the study. Each visit includes its study version and status when available.

Show Source

• Array of: object VisitDto

{
    "type":"array",
    "description":"Visits returned for the study. Each visit includes its study version and status when available.",
    "example":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "title":"Screening",
            "repeatVisit":false,
            "repeatNumber":0,
            "requiredVisit":true,
            "eventType":"ScreeningVisit",
            "shortName":"SCR",
            "studyVersion":"1.0.0.1",
            "studyVersionStatus":"TESTING"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDto"
    }
}

Example:

[
    {
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "title":"Screening",
        "repeatVisit":false,
        "repeatNumber":0,
        "requiredVisit":true,
        "eventType":"ScreeningVisit",
        "shortName":"SCR",
        "studyVersion":"1.0.0.1",
        "studyVersionStatus":"TESTING"
    }
]

Nested Schema : FormDto

Type: object

Show Source

• id: string (uuid)
  Form ID (UUID, 32-character uppercase hexadecimal string).
• items: array items
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form refname

  Example: FORM_01
• studyVersion: string
  Study version

  Example: 1.0.0.1
• studyVersionStatus: string
  Study version status

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

  Maximum Length: 64

  Form title

  Example: Demography

{
    "required":[
        "refname",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form ID (UUID, 32-character uppercase hexadecimal string).",
            "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"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtoV5"
            }
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "studyVersionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"TESTING"
        }
    }
}

Nested Schema : items

Type: array

Show Source

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

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV5", "numeric":"#/components/schemas/FormNumberItemDtoV5", "measurement":"#/components/schemas/FormNumberItemDtoV5", "text":"#/components/schemas/FormTextItemDtoV5", "choice":"#/components/schemas/FormChoiceItemDtoV5" } }

  Form Item Information

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

Nested Schema : FormItemDto v5.0

Type: object

Title: FormItemDto v5.0

Discriminator: questionType

Discriminator Values

• datetime
• numeric
• measurement
• text
• choice

{
    "title":"FormItemDto v5.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Source-Documented Verification: Whether proof of the answer required?",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "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"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtoV5",
            "numeric":"#/components/schemas/FormNumberItemDtoV5",
            "measurement":"#/components/schemas/FormNumberItemDtoV5",
            "text":"#/components/schemas/FormTextItemDtoV5",
            "choice":"#/components/schemas/FormChoiceItemDtoV5"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV5"
        }
    ]
}

Form Item Information

Show Source

• 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)'}]
• 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
• 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
• randomizationTag: boolean
  Flag that indicates whether this form item should be used for randomization stratification or not.

  Example: true
• 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}
• sdvRequired(required): boolean
  Source-Documented Verification: Whether proof of the answer required?

  Example: false
• 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 v5.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Source-Documented Verification: Whether proof of the answer required?",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "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"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtoV5",
            "numeric":"#/components/schemas/FormNumberItemDtoV5",
            "measurement":"#/components/schemas/FormNumberItemDtoV5",
            "text":"#/components/schemas/FormTextItemDtoV5",
            "choice":"#/components/schemas/FormChoiceItemDtoV5"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV5"
        }
    ]
}

Match One Schema

Show Source

• object FormNumberItemDto v5.0
  Title: FormNumberItemDto v5.0

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

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

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

  Form DateTime Item Details Information

{
    "title":"FormItemDto v5.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Source-Documented Verification: Whether proof of the answer required?",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "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"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtoV5",
            "numeric":"#/components/schemas/FormNumberItemDtoV5",
            "measurement":"#/components/schemas/FormNumberItemDtoV5",
            "text":"#/components/schemas/FormTextItemDtoV5",
            "choice":"#/components/schemas/FormChoiceItemDtoV5"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV5"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV5"
        }
    ]
}

Nested Schema : FormNumberItemDto v5.0

Type: object

Title: FormNumberItemDto v5.0

Form Number Item Details Information

Match All

Form Number Item Details Information

Form Number Item Details Information

Show Source

• object FormItemDto v5.0
  Title: FormItemDto v5.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV5", "numeric":"#/components/schemas/FormNumberItemDtoV5", "measurement":"#/components/schemas/FormNumberItemDtoV5", "text":"#/components/schemas/FormTextItemDtoV5", "choice":"#/components/schemas/FormChoiceItemDtoV5" } }

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

{
    "title":"FormNumberItemDto v5.0",
    "required":[
        "precision",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Number Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV5"
        },
        {
            "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 v5.0

Type: object

Title: FormChoiceItemDto v5.0

Form Choice Item Details Information

Match All

Form Choice Item Details Information

Form Choice Item Details Information

Show Source

• object FormItemDto v5.0
  Title: FormItemDto v5.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV5", "numeric":"#/components/schemas/FormNumberItemDtoV5", "measurement":"#/components/schemas/FormNumberItemDtoV5", "text":"#/components/schemas/FormTextItemDtoV5", "choice":"#/components/schemas/FormChoiceItemDtoV5" } }

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

{
    "title":"FormChoiceItemDto v5.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Choice Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV5"
        },
        {
            "type":"object",
            "properties":{
                "display":{
                    "pattern":"selectbox",
                    "type":"string",
                    "description":"Form choice item display in UI - Selectbox.",
                    "example":"selectbox"
                },
                "options":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormOptionDtoV5"
                    }
                }
            }
        }
    ]
}

Nested Schema : FormTextItemDto v5.0

Type: object

Title: FormTextItemDto v5.0

Form text Item Details Information

Match All

Form text Item Details Information

Form text Item Details Information

Show Source

• object FormItemDto v5.0
  Title: FormItemDto v5.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV5", "numeric":"#/components/schemas/FormNumberItemDtoV5", "measurement":"#/components/schemas/FormNumberItemDtoV5", "text":"#/components/schemas/FormTextItemDtoV5", "choice":"#/components/schemas/FormChoiceItemDtoV5" } }

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

{
    "title":"FormTextItemDto v5.0",
    "required":[
        "maxlength",
        "multiline",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form text Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV5"
        },
        {
            "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 v5.0

Type: object

Title: FormDatetimeItemDto v5.0

Form DateTime Item Details Information

Match All

Form DateTime Item Details Information

Form DateTime Item Details Information

Show Source

• object FormItemDto v5.0
  Title: FormItemDto v5.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV5", "numeric":"#/components/schemas/FormNumberItemDtoV5", "measurement":"#/components/schemas/FormNumberItemDtoV5", "text":"#/components/schemas/FormTextItemDtoV5", "choice":"#/components/schemas/FormChoiceItemDtoV5" } }

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

{
    "title":"FormDatetimeItemDto v5.0",
    "required":[
        "format",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form DateTime Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV5"
        },
        {
            "type":"object",
            "properties":{
                "format":{
                    "pattern":"yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm",
                    "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":{
                    "pattern":"yyyy|MMM-yyyy",
                    "type":"string",
                    "description":"Partial date format",
                    "example":"Jan-1993"
                }
            }
        }
    ]
}

Nested Schema : FormNumberItemDto v5.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 v5.0-allOf[1]

Type: object

Show Source

• display: string
  Pattern: selectbox

  Form choice item display in UI - Selectbox.

  Example: selectbox
• options: array options

{
    "type":"object",
    "properties":{
        "display":{
            "pattern":"selectbox",
            "type":"string",
            "description":"Form choice item display in UI - Selectbox.",
            "example":"selectbox"
        },
        "options":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormOptionDtoV5"
            }
        }
    }
}

Nested Schema : options

Type: array

Show Source

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

  Form choice item option details

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

Nested Schema : FormOptionDto v5.0

Type: object

Title: FormOptionDto v5.0

Form choice item option details

Show Source

• 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

  Pattern: [a-zA-Z0-9]+

  Form choice selectbox value for a one specific choice.

  Example: 1

{
    "title":"FormOptionDto v5.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,
            "pattern":"[a-zA-Z0-9]+",
            "type":"string",
            "description":"Form choice selectbox value for a one specific choice.",
            "example":"1"
        }
    },
    "description":"Form choice item option details"
}

Nested Schema : FormTextItemDto v5.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 v5.0-allOf[1]

Type: object

Show Source

• allowPartialDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Allow partial date

  Example: 1
• format: string
  Pattern: yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm

  Date time format

  Example: DD-MON-YYYY
• partialDate: string
  Pattern: yyyy|MMM-yyyy

  Partial date format

  Example: Jan-1993

{
    "type":"object",
    "properties":{
        "format":{
            "pattern":"yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm",
            "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":{
            "pattern":"yyyy|MMM-yyyy",
            "type":"string",
            "description":"Partial date format",
            "example":"Jan-1993"
        }
    }
}

Nested Schema : FormItemBasicDto

Type: object

Show Source

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

  Example: Demography
• formula: string
  Smart item formula.

  Example: [{"ruleName":"AGE","ruleExpression":"AgeInYears(AGE_DOB_01, visitDate)"}]
• 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
• 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: string
  Allowed Values: [ "TEXT", "INSTRUCTIONAL_TEXT", "NUMERIC", "DATETIME", "CHOICE", "QUESTION_GROUP", "TABLE", "LABEL", "SECTION", "EXISTING_DATA", "FILE_UPLOAD" ]

  Form question type.

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

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

  Maximum Length: 64

  Form item reference name.

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

  Example: true
• ruleSet: string
  A JSON-formatted rule set used to validate answers.

  Example: {"logicalOperator":"NONE","rules":[],"numberIndex":1}
• sdvRequired(required): boolean
  Whether source data verification is required for this question.

  Example: false
• 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
• studyVersion: string
  Study version

  Example: 1.0.0.1
• studyVersionStatus: string
  Study version status

  Example: TESTING

{
    "required":[
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "type":"string",
            "description":"Form question type.",
            "example":"TEXT",
            "enum":[
                "TEXT",
                "INSTRUCTIONAL_TEXT",
                "NUMERIC",
                "DATETIME",
                "CHOICE",
                "QUESTION_GROUP",
                "TABLE",
                "LABEL",
                "SECTION",
                "EXISTING_DATA",
                "FILE_UPLOAD"
            ]
        },
        "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"
        },
        "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"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is required.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted rule set used to validate answers.",
            "example":"{\"logicalOperator\":\"NONE\",\"rules\":[],\"numberIndex\":1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Whether source data verification is required for this question.",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "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"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "studyVersionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"TESTING"
        }
    }
}

Nested Schema : VisitDto

Type: object

Show Source

• endVisitId: string (uuid)
  End visit ID (UUID, 32-character uppercase hexadecimal string).
• eventType: string
  Visit event type

  Example: ScreeningVisit
• id: string (uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string).
• lastRequired: boolean
  Yes - if Visit is last required.

  Example: false
• randomization: string (uuid)
  Randomization ID (UUID, 32-character uppercase hexadecimal string).
• repeatNumber(required): integer (int32)
  Times to repeat Visit Design.

  Example: 5
• repeatVisit(required): boolean
  Yes - if Visit Design is repeating.

  Example: false
• requiredVisit(required): boolean
  Yes - if Visit Design is required.

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

  Maximum Length: 16

  Pattern: [a-zA-Z0-9]+

  Visit short name

  Example: Week1
• startVisitId: string (uuid)
  Start visit ID (UUID, 32-character uppercase hexadecimal string).
• studyVersion: string
  Study version

  Example: 1.0.0.1
• studyVersionStatus: string
  Study version status

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

  Maximum Length: 64

  Visit title

  Example: Week 2
• visitDescription: string
  Visit description

  Example: Regular 2 week visit
• visitStartDate: string (date-time)
  Visit start date time

  Example: 2019-01-25T07:42:00.204Z

{
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit title",
            "example":"Week 2"
        },
        "repeatVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating.",
            "example":false
        },
        "repeatNumber":{
            "type":"integer",
            "description":"Times to repeat Visit Design.",
            "format":"int32",
            "example":5
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit is last required.",
            "example":false
        },
        "eventType":{
            "type":"string",
            "description":"Visit event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "maxLength":16,
            "minLength":1,
            "pattern":"[a-zA-Z0-9]+",
            "type":"string",
            "description":"Visit short name",
            "example":"Week1"
        },
        "visitDescription":{
            "type":"string",
            "description":"Visit description",
            "example":"Regular 2 week visit"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date time",
            "format":"date-time",
            "example":"2019-01-25T07:42:00.204Z"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "studyVersionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"TESTING"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        }
    }
}

Examples

Select an example queryVisitsFormsV2Response

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

Back to Top