Jump to

• Request
• Response

[Deprecated]: V7.0

get

/ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign

Deprecated: Use latest version instead. Retrieves all the visits, forms and questionnaires in a study ID in one or more study versions and by mode.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• mode: string
  Study mode filter. Allowed values: design (draft design data), test (testing data), training (training data), active (approved production data), all (all modes). Optional.

  Default Value: test

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

  Example:

  test

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyDesignDto v7.0
  Title: StudyDesignDto v7.0

  Information about whole study design for subject .

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

Nested Schema : StudyDesignDto v7.0

Type: object

Title: StudyDesignDto v7.0

Information about whole study design for subject .

Show Source

• forms: object FormDto v15.0
  Title: FormDto v15.0

  A form definition returned for a study version.
• formSummary: object FormSummaryDto v1.0
  Title: FormSummaryDto v1.0

  Summary information for a study form returned by the V1.0 query forms API.
• studyVersionVisit: object StudyVersionVisitDto v7.0
  Title: StudyVersionVisitDto v7.0

  Information about a visit in a study version.
• visits: object StudyVisitScheduleWithFormIdsDto v7.0
  Title: StudyVisitScheduleWithFormIdsDto v7.0

  Information about visit schedule and visit forms id .

{
    "title":"StudyDesignDto v7.0",
    "type":"object",
    "properties":{
        "studyVersionVisit":{
            "$ref":"#/components/schemas/StudyVersionVisitDtoV7"
        },
        "visits":{
            "title":"StudyVisitScheduleWithFormIdsDto v7.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Branch GUID",
                    "format":"uuid"
                },
                "title":{
                    "type":"string",
                    "description":"Visit title",
                    "example":"Week2"
                },
                "shortName":{
                    "type":"string",
                    "description":"Visit shortname",
                    "example":"W2"
                },
                "fullName":{
                    "type":"string",
                    "description":"Concatenation of Visit Title and Branch title with hypen",
                    "example":"B1C01 - V01"
                },
                "eventType":{
                    "type":"string",
                    "description":"Visit event type",
                    "example":"ScreeningVisit"
                },
                "branchTitle":{
                    "type":"string",
                    "description":"Branch title",
                    "example":"Branch1"
                },
                "branchShortName":{
                    "type":"string",
                    "description":"Visit Branch shortName",
                    "example":"Br1"
                },
                "branchIsCycle":{
                    "type":"boolean",
                    "description":"The branch is cyclic or acyclic",
                    "example":true
                },
                "startCycle":{
                    "type":"integer",
                    "description":"Start Cycle Number",
                    "format":"int32"
                },
                "visitSchedule":{
                    "$ref":"#/components/schemas/StudyVisitScheduleDtoV7"
                },
                "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"
                    }
                },
                "cycleCount":{
                    "type":"number",
                    "description":"number of times a branch can cycle",
                    "example":10
                }
            },
            "description":"Information about visit schedule and visit forms id ."
        },
        "forms":{
            "title":"FormDto v15.0",
            "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":"Demographics"
                },
                "refname":{
                    "maxLength":64,
                    "minLength":1,
                    "type":"string",
                    "description":"Form reference name.",
                    "example":"DM"
                },
                "repeat":{
                    "type":"boolean",
                    "description":"Indicates whether the form repeats.",
                    "example":false
                },
                "source":{
                    "$ref":"#/components/schemas/FormCopySourceDtov15"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemDtov15"
                    }
                },
                "versionStart":{
                    "type":"string",
                    "description":"Version Start date",
                    "format":"date-time",
                    "example":"2018-11-23T08:43:01.7Z"
                },
                "dynamic":{
                    "type":"integer",
                    "description":"Number of form items that can dynamically show this form.",
                    "format":"int32",
                    "example":0
                },
                "formType":{
                    "type":"string",
                    "description":"Form type.",
                    "example":"STANDARD_FORM",
                    "enum":[
                        "STANDARD_FORM",
                        "LAB_FORM",
                        "TWO_SECTION_FORM",
                        "DRUG_RECONCILIATION_FORM",
                        "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM"
                    ]
                },
                "hasRevision":{
                    "type":"boolean",
                    "description":"Indicates whether revisions from a newer study version have been applied.",
                    "example":false
                },
                "linkFrom":{
                    "type":"array",
                    "description":"linked from forms",
                    "items":{
                        "$ref":"#/components/schemas/FormLinkFromDtov15"
                    }
                },
                "showFrom":{
                    "type":"array",
                    "description":"show dynamic parent from forms of same visit",
                    "items":{
                        "$ref":"#/components/schemas/FormLinkFromDtov15"
                    }
                },
                "assignedVisits":{
                    "type":"array",
                    "description":"branch cycle information describing the visits on which the forms are displayed",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov15"
                    }
                }
            },
            "description":"A form definition returned for a study version.",
            "example":{
                "id":"B1B8327AFAA6412287106192AB5984EF",
                "title":"Demographics",
                "refname":"DM",
                "repeat":false,
                "dynamic":0,
                "formType":"STANDARD_FORM",
                "items":[
                    {
                        "id":"C2C8327AFAA6412287106192AB5984EF",
                        "questionType":"text",
                        "questionLabel":"Date of birth",
                        "refname":"DOB_01",
                        "required":true,
                        "sequence":1
                    }
                ]
            }
        },
        "formSummary":{
            "title":"FormSummaryDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Form ID. UUID, 32-character uppercase hexadecimal string.",
                    "format":"uuid"
                },
                "refname":{
                    "type":"string",
                    "description":"Reference name for the form.",
                    "example":"DEMOGRAPHICS"
                },
                "title":{
                    "type":"string",
                    "description":"Display title for the form.",
                    "example":"Demographics"
                },
                "items":{
                    "type":"array",
                    "description":"Form item summaries.",
                    "example":[
                        {
                            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                            "refname":"AGE",
                            "questionType":"numeric",
                            "questionLabel":"Age"
                        }
                    ],
                    "items":{
                        "$ref":"#/components/schemas/FormItemSummaryDtoV1"
                    }
                }
            },
            "description":"Summary information for a study form returned by the V1.0 query forms API.",
            "example":{
                "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
                "refname":"DEMOGRAPHICS",
                "title":"Demographics",
                "items":[
                    {
                        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                        "refname":"AGE",
                        "questionType":"numeric",
                        "questionLabel":"Age"
                    }
                ]
            }
        }
    },
    "description":"Information about whole study design for subject ."
}

Nested Schema : FormDto v15.0

Type: object

Title: FormDto v15.0

A form definition returned for a study version.

Show Source

• assignedVisits: array assignedVisits
  branch cycle information describing the visits on which the forms are displayed
• dynamic: integer (int32)
  Number of form items that can dynamically show this form.

  Example: 0
• formType: string
  Allowed Values: [ "STANDARD_FORM", "LAB_FORM", "TWO_SECTION_FORM", "DRUG_RECONCILIATION_FORM", "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM" ]

  Form type.

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

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

  Maximum Length: 64

  Form reference name.

  Example: DM
• repeat: boolean
  Indicates whether the form repeats.

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

  Form Copy Source Information
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form title.

  Example: Demographics
• versionStart: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z

{
    "title":"FormDto v15.0",
    "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":"Demographics"
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form reference name.",
            "example":"DM"
        },
        "repeat":{
            "type":"boolean",
            "description":"Indicates whether the form repeats.",
            "example":false
        },
        "source":{
            "$ref":"#/components/schemas/FormCopySourceDtov15"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtov15"
            }
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "dynamic":{
            "type":"integer",
            "description":"Number of form items that can dynamically show this form.",
            "format":"int32",
            "example":0
        },
        "formType":{
            "type":"string",
            "description":"Form type.",
            "example":"STANDARD_FORM",
            "enum":[
                "STANDARD_FORM",
                "LAB_FORM",
                "TWO_SECTION_FORM",
                "DRUG_RECONCILIATION_FORM",
                "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM"
            ]
        },
        "hasRevision":{
            "type":"boolean",
            "description":"Indicates whether revisions from a newer study version have been applied.",
            "example":false
        },
        "linkFrom":{
            "type":"array",
            "description":"linked from forms",
            "items":{
                "$ref":"#/components/schemas/FormLinkFromDtov15"
            }
        },
        "showFrom":{
            "type":"array",
            "description":"show dynamic parent from forms of same visit",
            "items":{
                "$ref":"#/components/schemas/FormLinkFromDtov15"
            }
        },
        "assignedVisits":{
            "type":"array",
            "description":"branch cycle information describing the visits on which the forms are displayed",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov15"
            }
        }
    },
    "description":"A form definition returned for a study version.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "title":"Demographics",
        "refname":"DM",
        "repeat":false,
        "dynamic":0,
        "formType":"STANDARD_FORM",
        "items":[
            {
                "id":"C2C8327AFAA6412287106192AB5984EF",
                "questionType":"text",
                "questionLabel":"Date of birth",
                "refname":"DOB_01",
                "required":true,
                "sequence":1
            }
        ]
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "title":"Demographics",
    "refname":"DM",
    "repeat":false,
    "dynamic":0,
    "formType":"STANDARD_FORM",
    "items":[
        {
            "id":"C2C8327AFAA6412287106192AB5984EF",
            "questionType":"text",
            "questionLabel":"Date of birth",
            "refname":"DOB_01",
            "required":true,
            "sequence":1
        }
    ]
}

Nested Schema : FormSummaryDto v1.0

Type: object

Title: FormSummaryDto v1.0

Summary information for a study form returned by the V1.0 query forms API.

Show Source

• id: string (uuid)
  Form ID. UUID, 32-character uppercase hexadecimal string.
• items: array items
  Form item summaries.
• refname: string
  Reference name for the form.

  Example: DEMOGRAPHICS
• title: string
  Display title for the form.

  Example: Demographics

{
    "title":"FormSummaryDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Reference name for the form.",
            "example":"DEMOGRAPHICS"
        },
        "title":{
            "type":"string",
            "description":"Display title for the form.",
            "example":"Demographics"
        },
        "items":{
            "type":"array",
            "description":"Form item summaries.",
            "example":[
                {
                    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                    "refname":"AGE",
                    "questionType":"numeric",
                    "questionLabel":"Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemSummaryDtoV1"
            }
        }
    },
    "description":"Summary information for a study form returned by the V1.0 query forms API.",
    "example":{
        "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "refname":"DEMOGRAPHICS",
        "title":"Demographics",
        "items":[
            {
                "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                "refname":"AGE",
                "questionType":"numeric",
                "questionLabel":"Age"
            }
        ]
    }
}

Example:

{
    "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "refname":"DEMOGRAPHICS",
    "title":"Demographics",
    "items":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ]
}

Nested Schema : StudyVersionVisitDto v7.0

Type: object

Title: StudyVersionVisitDto v7.0

Information about a visit in a study version.

Show Source

• studyId: string (uuid)
• studyTitle: string
  Study name

  Example: Study 03
• version: string
  version

  Example: 1.3.0.6
• versionPreviousStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Previous study status

  Example: TESTING
• versionStatus: string
  Study version status

  Example: Active, not recruiting
• visitId: string (uuid)
  Visit GUID

{
    "title":"StudyVersionVisitDto v7.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    },
    "description":"Information about a visit in a study version."
}

Nested Schema : StudyVisitScheduleWithFormIdsDto v7.0

Type: object

Title: StudyVisitScheduleWithFormIdsDto v7.0

Information about visit schedule and visit forms id .

Show Source

• branchIsCycle: boolean
  The branch is cyclic or acyclic

  Example: true
• branchShortName: string
  Visit Branch shortName

  Example: Br1
• branchTitle: string
  Branch title

  Example: Branch1
• cycleCount: number
  number of times a branch can cycle

  Example: 10
• eventType: string
  Visit event type

  Example: ScreeningVisit
• formIds: array formIds
  List of visit forms IDs
• fullName: string
  Concatenation of Visit Title and Branch title with hypen

  Example: B1C01 - V01
• id: string (uuid)
  Branch GUID
• shortName: string
  Visit shortname

  Example: W2
• startCycle: integer (int32)
  Start Cycle Number
• title: string
  Visit title

  Example: Week2
• visitSchedule: object StudyVisitScheduleDto v7.0
  Title: StudyVisitScheduleDto v7.0

  Study visit schedule details.

{
    "title":"StudyVisitScheduleWithFormIdsDto v7.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Branch GUID",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit title",
            "example":"Week2"
        },
        "shortName":{
            "type":"string",
            "description":"Visit shortname",
            "example":"W2"
        },
        "fullName":{
            "type":"string",
            "description":"Concatenation of Visit Title and Branch title with hypen",
            "example":"B1C01 - V01"
        },
        "eventType":{
            "type":"string",
            "description":"Visit event type",
            "example":"ScreeningVisit"
        },
        "branchTitle":{
            "type":"string",
            "description":"Branch title",
            "example":"Branch1"
        },
        "branchShortName":{
            "type":"string",
            "description":"Visit Branch shortName",
            "example":"Br1"
        },
        "branchIsCycle":{
            "type":"boolean",
            "description":"The branch is cyclic or acyclic",
            "example":true
        },
        "startCycle":{
            "type":"integer",
            "description":"Start Cycle Number",
            "format":"int32"
        },
        "visitSchedule":{
            "$ref":"#/components/schemas/StudyVisitScheduleDtoV7"
        },
        "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"
            }
        },
        "cycleCount":{
            "type":"number",
            "description":"number of times a branch can cycle",
            "example":10
        }
    },
    "description":"Information about visit schedule and visit forms id ."
}

Nested Schema : assignedVisits

Type: array

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

Show Source

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

  Form Item Advanced Property with Parent Info

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

Nested Schema : items

Type: array

Show Source

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

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

  Form Item Information

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

Nested Schema : linkFrom

Type: array

linked from forms

Show Source

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

  Linked From Form Details

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

Nested Schema : showFrom

Type: array

show dynamic parent from forms of same visit

Show Source

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

  Linked From Form Details

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

Nested Schema : FormCopySourceDto v15.0

Type: object

Title: FormCopySourceDto v15.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: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z
• versionstart: boolean
  is Rules Copied

  Example: false

{
    "title":"FormCopySourceDto v15.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":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionstart":{
            "type":"boolean",
            "description":"is Rules Copied",
            "example":false
        }
    },
    "description":"Form Copy Source Information"
}

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

Type: object

Title: From Item Advanced Property With Parent v15.0

Form Item Advanced Property with Parent Info

Show Source

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

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• parentObjectLabel: string
  parent object name

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

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

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

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

Nested Schema : rules

Type: array

Show Source

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

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v15.0

Type: object

Title: From Item Advanced Property Rule v15.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 v15.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : FormItemDto v15.0

Type: object

Title: FormItemDto v15.0

Discriminator: questionType

Discriminator Values

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

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

Form Item Information

Show Source

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

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

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

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

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

  Example: Demography
• formula: string
  Smart item formula.

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

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

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

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

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

  Maximum Length: 4000

  Form question hint

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

  Maximum Length: 4000

  Form question label

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

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

  Question type

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

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

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

  Maximum Length: 64

  Form item reference name.

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

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

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

  Example: Adverse Event
• sasVariable: string
  Form Item SASVariable

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

  Source Data Verification Type

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

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

  Example: AGE

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

Match One Schema

Show Source

• object FormNumberItemDto v15.0
  Title: FormNumberItemDto v15.0

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

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

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

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

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

  Form table Item Details Information
• object FormLabelItemDto

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

Nested Schema : advancedProps

Type: array

Show Source

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

  Form Item Advanced Property

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

Nested Schema : dataClassificationIds

Type: array

Show Source

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

  Form Item Advanced Property

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

Nested Schema : FormNumberItemDto v15.0

Type: object

Title: FormNumberItemDto v15.0

Form Number Item Details Information

Match All

Form Number Item Details Information

Form Number Item Details Information

Show Source

• object FormItemDto v15.0
  Title: FormItemDto v15.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

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

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

Type: object

Title: FormChoiceItemDto v15.0

Form Choice Item Details Information

Match All

Form Choice Item Details Information

Form Choice Item Details Information

Show Source

• object FormItemDto v15.0
  Title: FormItemDto v15.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

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

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

Nested Schema : FormTextItemDto v15.0

Type: object

Title: FormTextItemDto v15.0

Form text Item Details Information

Match All

Form text Item Details Information

Form text Item Details Information

Show Source

• object FormItemDto v15.0
  Title: FormItemDto v15.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

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

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

Type: object

Title: FormDatetimeItemDto v15.0

Form DateTime Item Details Information

Match All

Form DateTime Item Details Information

Form DateTime Item Details Information

Show Source

• object FormItemDto v15.0
  Title: FormItemDto v15.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

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

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

Nested Schema : FormQuestionGroupItemDto v15.0

Type: object

Title: FormQuestionGroupItemDto v15.0

Form Question Group Item Details Information

Match All

Form Question Group Item Details Information

Show Source

• object FormItemDto v15.0
  Title: FormItemDto v15.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

  Form Item Information

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

Nested Schema : FormTableItemDto v15.0

Type: object

Title: FormTableItemDto v15.0

Form table Item Details Information

Match All

Form table Item Details Information

Form table Item Details Information

Show Source

• object FormItemDto v15.0
  Title: FormItemDto v15.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov15", "numeric":"#/components/schemas/FormNumberItemDtov15", "measurement":"#/components/schemas/FormNumberItemDtov15", "text":"#/components/schemas/FormTextItemDtov15", "choice":"#/components/schemas/FormChoiceItemDtov15", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov15", "table":"#/components/schemas/FormTableItemDtov15", "label":"#/components/schemas/FormLabelItemDto" } }

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

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

Nested Schema : FormLabelItemDto

Type: object

Match All

Show Source

• object FormItemDto v16.0
  Title: FormItemDto v16.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov16", "numeric":"#/components/schemas/FormNumberItemDtov16", "measurement":"#/components/schemas/FormNumberItemDtov16", "text":"#/components/schemas/FormTextItemDtov16", "choice":"#/components/schemas/FormChoiceItemDtov16", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov16", "table":"#/components/schemas/FormTableItemDtov16", "label":"#/components/schemas/FormLabelItemDto" } }

  Form Item Information
• object FormLabelItemDto-allOf[1]

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

Nested Schema : From Item Advanced Property v15.0

Type: object

Title: From Item Advanced Property v15.0

Form Item Advanced Property

Show Source

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

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

  Maximum Length: 255

  Advanced property name

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

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v15.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov15"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

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

  Form Item Advanced Property Rule

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

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

Type: object

Show Source

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

  Maximum Length: 4000

  Codelist description only for choice type formitem

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

  Example: Gender
• columnLayout: string
  Coumn Layout codelist ID

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

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

  Form choice item display in UI - Selectbox.

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

  Example: true
• options: array options

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

Nested Schema : advancedProps

Type: array

Show Source

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

  Form Item Advanced Property with Parent Info

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

Nested Schema : options

Type: array

Show Source

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

  Form choice item option details

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

Nested Schema : FormOptionDto v15.0

Type: object

Title: FormOptionDto v15.0

Form choice item option details

Show Source

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

  Example: 1
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description for a one specific choice.

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

  Example: 1
• label: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox label for a one specific choice.

  Example: Female
• value: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox value for a one specific choice.

  Example: 1

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

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

Type: object

Show Source

• allowPartialDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Allow partial date

  Example: 1
• format: string
  Date time format

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

  Example: Jan-1993

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

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

Type: object

Show Source

• allowAdditionalRows: boolean

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

Nested Schema : FormItemDto v16.0

Type: object

Title: FormItemDto v16.0

Discriminator: questionType

Discriminator Values

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

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

Form Item Information

Show Source

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

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

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

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

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

  Example: Demography
• formula: string
  Smart item formula.

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

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

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

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

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

  Maximum Length: 4000

  Form question hint

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

  Maximum Length: 4000

  Form question label

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

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

  Question type

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

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

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

  Maximum Length: 64

  Form item reference name.

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

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

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

  Example: Adverse Event
• sasVariable: string
  Form Item SASVariable

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

  Source Data Verification Type

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

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

  Example: AGE

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

Match One Schema

Show Source

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

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

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

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

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

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

  Form table Item Details Information
• object FormLabelItemDto

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

Nested Schema : FormLabelItemDto-allOf[1]

Type: object

Show Source

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

  Maximum Length: 4000

  Codelist description only for choice type formitem

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

  Example: Gender
• columnLayout: string
  Coumn Layout codelist ID

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

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

  Form choice item display in UI - Selectbox.

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

  Example: true
• options: array options

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

Nested Schema : advancedProps

Type: array

Show Source

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

  Form Item Advanced Property with Parent Info

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

Nested Schema : options

Type: array

Show Source

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

  Form choice item option details

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

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

Type: object

Title: From Item Advanced Property With Parent v16.0

Form Item Advanced Property with Parent Info

Show Source

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

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• parentObjectLabel: string
  parent object name

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

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

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

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

Nested Schema : rules

Type: array

Show Source

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

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v16.0

Type: object

Title: From Item Advanced Property Rule v16.0

Form Item Advanced Property Rule

Show Source

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

  Example: Yes
• name: string
  name

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

  Example: B1B8327AFAA6412287106192AB5984EF

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

Nested Schema : FormOptionDto v16.0

Type: object

Title: FormOptionDto v16.0

Form choice item option details

Show Source

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

  Example: 1
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description for a one specific choice.

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

  Example: 1
• label: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox label for a one specific choice.

  Example: Female
• value: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox value for a one specific choice.

  Example: 1

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

Nested Schema : FormLinkFromDto v15.0

Type: object

Title: FormLinkFromDto v15.0

Linked From Form Details

Show Source

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

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

Nested Schema : items

Type: array

Form items

Show Source

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

  Form Item Advanced Property with Parent Info

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

Nested Schema : parentAssignedVisits

Type: array

Parent Assigned Visits

Show Source

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

  Form Item Advanced Property with Parent Info

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

Nested Schema : items

Type: array

Form item summaries.

Show Source

• Array of: object FormItemSummaryDto v1.0
  Title: FormItemSummaryDto v1.0

  Summary information for a form item returned by the V1.0 query forms API.

{
    "type":"array",
    "description":"Form item summaries.",
    "example":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemSummaryDtoV1"
    }
}

Example:

[
    {
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "refname":"AGE",
        "questionType":"numeric",
        "questionLabel":"Age"
    }
]

Nested Schema : FormItemSummaryDto v1.0

Type: object

Title: FormItemSummaryDto v1.0

Summary information for a form item returned by the V1.0 query forms API.

Show Source

• id: string (uuid)
  Form item ID. UUID, 32-character uppercase hexadecimal string.
• questionLabel: string
  Display label for the question.

  Example: Age
• questionType: string
  Title: FormItemType

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

  Question type for the form item.

  Example: numeric
• refname: string
  Reference name for the form item.

  Example: AGE
• subItemIds: string (uuid)
  Title: Sub item ids

  IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.

{
    "title":"FormItemSummaryDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form item ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Reference name for the form item.",
            "example":"AGE"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type for the form item.",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Display label for the question.",
            "example":"Age"
        },
        "subItemIds":{
            "title":"Sub item ids",
            "type":"string",
            "description":"IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        }
    },
    "description":"Summary information for a form item returned by the V1.0 query forms API.",
    "example":{
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "refname":"AGE",
        "questionType":"numeric",
        "questionLabel":"Age"
    }
}

Example:

{
    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
    "refname":"AGE",
    "questionType":"numeric",
    "questionLabel":"Age"
}

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 v7.0

Type: object

Title: StudyVisitScheduleDto v7.0

Study visit schedule details.

Show Source

• branchId: string (uuid)
  Branch Id
• 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 date

  Example: 2018-11-23T08:43:01.7Z
• visitScheduleId: string (uuid)
  Visit schedule GUID

{
    "title":"StudyVisitScheduleDto v7.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit schedule GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "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"
        },
        "branchId":{
            "type":"string",
            "description":"Branch Id",
            "format":"uuid"
        },
        "sequenced":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Study visit schedule details."
}

Examples

Select an example successResponse

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