REST API for Clinical One Platform

Root Schema : schema

Type: array

Show Source

Array of: object StudyDesignDto v1.0

Title: StudyDesignDto v1.0

Information about whole study design for subject .

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

Nested Schema : StudyDesignDto v1.0

Type: object

Title: StudyDesignDto v1.0

Information about whole study design for subject .

Show Source

forms: object FormDto v10.0

Title: FormDto v10.0

Form Info
studyVersionVisitV1: object StudyVersionVisitDto v1.0

Title: StudyVersionVisitDto v1.0

Information about a visit in a study version.
visitsWithFormIds: object StudyVisitScheduleWithFormIdsDto v1.0

Title: StudyVisitScheduleWithFormIdsDto v1.0

Information about visit schedule and visit forms id .

{
    "title":"StudyDesignDto v1.0",
    "type":"object",
    "properties":{
        "studyVersionVisitV1":{
            "$ref":"#/components/schemas/StudyVersionVisitDtoV1"
        },
        "visitsWithFormIds":{
            "title":"StudyVisitScheduleWithFormIdsDto v1.0",
            "type":"object",
            "properties":{
                "visits":{
                    "$ref":"#/components/schemas/StudyVisitScheduleDtoV5"
                },
                "formIds":{
                    "type":"array",
                    "description":"list of Visit forms IDs",
                    "format":"uuid",
                    "example":[
                        "938D23FA6B7241CCA41BD627E5DB60DA",
                        "699EF3745FC545589F186D2198F3C65E"
                    ],
                    "items":{
                        "type":"string",
                        "description":"list of Visit forms IDs",
                        "format":"uuid"
                    }
                }
            },
            "description":"Information about visit schedule and visit forms id ."
        },
        "forms":{
            "title":"FormDto v10.0",
            "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/FormCopySourceDtov10"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemDtov10"
                    }
                },
                "versionStart":{
                    "type":"string",
                    "description":"The form's version date",
                    "format":"date-time"
                },
                "dynamic":{
                    "type":"integer",
                    "description":"Count of forms items that point to this form for Show Form feature",
                    "format":"int32",
                    "example":"4"
                }
            },
            "description":"Form Info"
        }
    },
    "description":"Information about whole study design for subject ."
}

Nested Schema : FormDto v10.0

Type: object

Title: FormDto v10.0

Form Info

Show Source

dynamic: integer (int32)

Count of forms items that point to this form for Show Form feature

Example: 4
id: string (uuid)

Form Unique GUID
items: array items
refname(required): string

Minimum Length: 1

Maximum Length: 64

Form refname

Example: FORM_01
repeat: boolean

Form repeating?

Example: false
source: object FormCopySourceDto v10.0

Title: FormCopySourceDto v10.0

Form Copy Source Information
title(required): string

Minimum Length: 1

Maximum Length: 64

Form title

Example: Demography
versionStart: string (date-time)

The form's version date

{
    "title":"FormDto v10.0",
    "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/FormCopySourceDtov10"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtov10"
            }
        },
        "versionStart":{
            "type":"string",
            "description":"The form's version date",
            "format":"date-time"
        },
        "dynamic":{
            "type":"integer",
            "description":"Count of forms items that point to this form for Show Form feature",
            "format":"int32",
            "example":"4"
        }
    },
    "description":"Form Info"
}

Nested Schema : StudyVersionVisitDto v1.0

Type: object

Title: StudyVersionVisitDto v1.0

Information about a visit in a study version.

Show Source

studyId: string (uuid)
studyTitle: string
studyVersion: string
visitId: string (uuid)

Visit GUID

{
    "title":"StudyVersionVisitDto v1.0",
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "studyTitle":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        }
    },
    "description":"Information about a visit in a study version."
}

Nested Schema : StudyVisitScheduleWithFormIdsDto v1.0

Type: object

Title: StudyVisitScheduleWithFormIdsDto v1.0

Information about visit schedule and visit forms id .

Show Source

formIds: array formIds

list of Visit forms IDs
visits: object StudyVisitScheduleDto v5.0

Title: StudyVisitScheduleDto v5.0

Study visit schedule details.

{
    "title":"StudyVisitScheduleWithFormIdsDto v1.0",
    "type":"object",
    "properties":{
        "visits":{
            "$ref":"#/components/schemas/StudyVisitScheduleDtoV5"
        },
        "formIds":{
            "type":"array",
            "description":"list of Visit forms IDs",
            "format":"uuid",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of Visit forms IDs",
                "format":"uuid"
            }
        }
    },
    "description":"Information about visit schedule and visit forms id ."
}

Nested Schema : items

Type: array

Show Source

Array of: object FormItemDto v10.0

Title: FormItemDto v10.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }

Form Item Information

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

Nested Schema : FormCopySourceDto v10.0

Type: object

Title: FormCopySourceDto v10.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 v10.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 : FormItemDto v10.0

Type: object

Title: FormItemDto v10.0

Discriminator: questionType

{
    "title":"FormItemDto v10.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
        },
        "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":"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"
        },
        "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/FormItemAdvancedPropDtov10"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov10",
            "numeric":"#/components/schemas/FormNumberItemDtov10",
            "measurement":"#/components/schemas/FormNumberItemDtov10",
            "text":"#/components/schemas/FormTextItemDtov10",
            "choice":"#/components/schemas/FormChoiceItemDtov10",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov10"
        }
    ]
}

Form Item Information

Show Source

advancedProps: array advancedProps
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
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
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): 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 v10.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
        },
        "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":"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"
        },
        "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/FormItemAdvancedPropDtov10"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov10",
            "numeric":"#/components/schemas/FormNumberItemDtov10",
            "measurement":"#/components/schemas/FormNumberItemDtov10",
            "text":"#/components/schemas/FormTextItemDtov10",
            "choice":"#/components/schemas/FormChoiceItemDtov10",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov10"
        }
    ]
}

Match One Schema

Show Source

object FormNumberItemDto v10.0

Title: FormNumberItemDto v10.0

Form Number Item Details Information
object FormChoiceItemDto v10.0

Title: FormChoiceItemDto v10.0

Form Choice Item Details Information
object FormTextItemDto v10.0

Title: FormTextItemDto v10.0

Form text Item Details Information
object FormDatetimeItemDto v10.0

Title: FormDatetimeItemDto v10.0

Form DateTime Item Details Information
object FormQuestionGroupItemDto v10.0

Title: FormQuestionGroupItemDto v10.0

Form Question Group Item Details Information

{
    "title":"FormItemDto v10.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
        },
        "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":"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"
        },
        "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/FormItemAdvancedPropDtov10"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov10",
            "numeric":"#/components/schemas/FormNumberItemDtov10",
            "measurement":"#/components/schemas/FormNumberItemDtov10",
            "text":"#/components/schemas/FormTextItemDtov10",
            "choice":"#/components/schemas/FormChoiceItemDtov10",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov10"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov10"
        }
    ]
}

Nested Schema : advancedProps

Type: array

Show Source

Array of: object From Item Advanced Property v10.0

Title: From Item Advanced Property v10.0

Form Item Advanced Property

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

Nested Schema : FormNumberItemDto v10.0

Type: object

Title: FormNumberItemDto v10.0

Form Number Item Details Information

Match All

Show Source

object FormItemDto v10.0

Title: FormItemDto v10.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }

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

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

Type: object

Title: FormChoiceItemDto v10.0

Form Choice Item Details Information

Match All

Show Source

object FormItemDto v10.0

Title: FormItemDto v10.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }

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

{
    "title":"FormChoiceItemDto v10.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Choice Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov10"
        },
        {
            "type":"object",
            "properties":{
                "display":{
                    "pattern":"selectbox|checkbox|radioset",
                    "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/FormOptionDtov10"
                    }
                },
                "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"
                }
            }
        }
    ]
}

Nested Schema : FormTextItemDto v10.0

Type: object

Title: FormTextItemDto v10.0

Form text Item Details Information

Match All

Show Source

object FormItemDto v10.0

Title: FormItemDto v10.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }

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

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

Type: object

Title: FormDatetimeItemDto v10.0

Form DateTime Item Details Information

Match All

Show Source

object FormItemDto v10.0

Title: FormItemDto v10.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }

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

{
    "title":"FormDatetimeItemDto v10.0",
    "required":[
        "format",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form DateTime Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov10"
        },
        {
            "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 : FormQuestionGroupItemDto v10.0

Type: object

Title: FormQuestionGroupItemDto v10.0

Form Question Group Item Details Information

Match All

Show Source

object FormItemDto v10.0

Title: FormItemDto v10.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov10", "numeric":"#/components/schemas/FormNumberItemDtov10", "measurement":"#/components/schemas/FormNumberItemDtov10", "text":"#/components/schemas/FormTextItemDtov10", "choice":"#/components/schemas/FormChoiceItemDtov10", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov10" } }

Form Item Information

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

Nested Schema : From Item Advanced Property v10.0

Type: object

Title: From Item Advanced Property v10.0

Form Item Advanced Property

Show Source

id: string (uuid)

Extended Property ID
label: string

Rollover study name

Example: Rollover Study BT-31
name(required): string

Minimum Length: 1

Maximum Length: 255

Advanced property name

Example: RolloverQuestionStudyId
rules: array rules
value(required): string

Minimum Length: 1

Maximum Length: 2048

Advanced property value. For example, rollover study UUID

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v10.0",
    "required":[
        "name",
        "value"
    ],
    "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/FormItemAdvancedPropRuleDtov10"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

Array of: object From Item Advanced Property Rule v10.0

Title: From Item Advanced Property Rule v10.0

Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v10.0

Type: object

Title: From Item Advanced Property Rule v10.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 v10.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 : FormNumberItemDto v10.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 v10.0-allOf[1]

Type: object

Show Source

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

Form choice item display in UI - Selectbox.

Example: selectbox
options: array options

{
    "type":"object",
    "properties":{
        "display":{
            "pattern":"selectbox|checkbox|radioset",
            "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/FormOptionDtov10"
            }
        },
        "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"
        }
    }
}

Nested Schema : options

Type: array

Show Source

Array of: object FormOptionDto v10.0

Title: FormOptionDto v10.0

Form choice item option details

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

Nested Schema : FormOptionDto v10.0

Type: object

Title: FormOptionDto v10.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
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 v10.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"
        }
    },
    "description":"Form choice item option details"
}

Nested Schema : FormTextItemDto v10.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 v10.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 : formIds

Type: array

list of Visit forms IDs

Show Source

Array of: string(uuid)

list of Visit forms IDs

{
    "type":"array",
    "description":"list of Visit forms IDs",
    "format":"uuid",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of Visit forms IDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Nested Schema : StudyVisitScheduleDto v5.0

Type: object

Title: StudyVisitScheduleDto v5.0

Study visit schedule details.

Show Source

dynamic: boolean

Yes - if visit dynamic.

Example: false
endVisitId: string (uuid)

End visit ID
eventType: string

Event randomization type

Example: Blinded
formCount: integer (int32)

Visit forms count

Example: 1
fromVisitId: string (uuid)

Scheduled from visit GUID
fromVisitTitle: string

Scheduled from visit title

Example: Week1
id: string (uuid)

Visit schedule GUID
kitCount: integer (int32)

Visit kits count

Example: 1
lastRequired: boolean

Yes - if visit last required.

Example: false
randomizationId: string (uuid)

Randomization GUID
refName: string

Country name

Example: WEEK2
repeating: boolean

Yes - if visit repeating.

Example: false
required: integer (int32)

Visit scheduling delay window after (hours).

Example: 1
screening: integer (int32)

1 - visit is screening

Example: 1
sequenced: integer (int32)
shortName: string

Event short name

Example: Week2
startVisitId: string (uuid)

Start visit ID
studyId: string (uuid)

Study GUID
studyVersionStart: string (date-time)

Study version start
title: string

Visit title

Example: Week2
type: string

Visit type

Example: ONSITE
versionEnd: string (date-time)

Version end
versionStart: string (date-time)

Version start
visitScheduleId: string (uuid)

Visit schedule GUID

{
    "title":"StudyVisitScheduleDto v5.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit schedule GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "visitScheduleId":{
            "type":"string",
            "description":"Visit schedule GUID",
            "format":"uuid"
        },
        "randomizationId":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "fromVisitId":{
            "type":"string",
            "description":"Scheduled from visit GUID",
            "format":"uuid"
        },
        "fromVisitTitle":{
            "type":"string",
            "description":"Scheduled from visit title",
            "example":"Week1"
        },
        "title":{
            "type":"string",
            "description":"Visit title",
            "example":"Week2"
        },
        "refName":{
            "type":"string",
            "description":"Country name",
            "example":"WEEK2"
        },
        "screening":{
            "type":"integer",
            "description":"1 - visit is screening",
            "format":"int32",
            "example":"1"
        },
        "formCount":{
            "type":"integer",
            "description":"Visit forms count",
            "format":"int32",
            "example":"1"
        },
        "kitCount":{
            "type":"integer",
            "description":"Visit kits count",
            "format":"int32",
            "example":"1"
        },
        "dynamic":{
            "type":"boolean",
            "description":"Yes - if visit dynamic.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Yes - if visit repeating.",
            "example":false
        },
        "required":{
            "type":"integer",
            "description":"Visit scheduling delay window after (hours).",
            "format":"int32",
            "example":"1"
        },
        "type":{
            "type":"string",
            "description":"Visit type",
            "example":"ONSITE"
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if visit last required.",
            "example":false
        },
        "eventType":{
            "type":"string",
            "description":"Event randomization type",
            "example":"Blinded"
        },
        "shortName":{
            "type":"string",
            "description":"Event short name",
            "example":"Week2"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID",
            "format":"uuid"
        },
        "sequenced":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Study visit schedule details."
}

Create all visits, forms and questionnaires

Request

Response

200 Response

Discriminator Values

500 Response