Jump to

• Request
• Response

V6.0

get

/ec-designer-svc/rest/v6.0/studies/{studyId}/studyversionobjects

Returns study version objects grouped by study version. Compared with v5.0, this version adds formCategory filtering and returns the v9 study-version-object response shape.

Request

Path Parameters

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

Query Parameters

• formCategory: string
  Return forms with this Form Category. Optional.

  Default Value: DCS

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : AllStudyVersionsObjectsDto v9.0

Type: object

Title: AllStudyVersionsObjectsDto v9.0

Objects of all study versions.

Show Source

• studyId: string (uuid)
  Study GUID
• versions: array versions

{
    "title":"AllStudyVersionsObjectsDto v9.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "versions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/versions"
            }
        }
    },
    "description":"Objects of all study versions."
}

Nested Schema : versions

Type: array

Show Source

• Array of: object VersionObjectsDto v9.0
  Title: VersionObjectsDto v9.0

  Objects information of all study versions.

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

Nested Schema : VersionObjectsDto v9.0

Type: object

Title: VersionObjectsDto v9.0

Objects information of all study versions.

Show Source

• studyVersionObjects: object StudyVersionObjectsDto
• version: string

{
    "title":"VersionObjectsDto v9.0",
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "studyVersionObjects":{
            "$ref":"#/components/schemas/StudyVersionObjectsDto"
        }
    },
    "description":"Objects information of all study versions."
}

Nested Schema : StudyVersionObjectsDto

Type: object

Show Source

• advanceDosingGroupCriterias: array advanceDosingGroupCriterias
• advanceDosingGroupKitSettings: array advanceDosingGroupKitSettings
• advanceDosingGroups: array advanceDosingGroups
• armKitVisits: array armKitVisits
• branches: array branches
• codeListItems: array codeListItems
• codeLists: array codeLists
• cohorts: array cohorts
• dataViews: array dataViews
• dosingCalculations: array dosingCalculations
• extendedProperties: array extendedProperties
• formItems: array formItems
• kits: array kits
• randArmRatios: array randArmRatios
• randCohortFactors: array randCohortFactors
• randomizations: array randomizations
• randStratumFactors: array randStratumFactors
• stratum: array stratum
• stringResources: array stringResources
• studyEventForms: array studyEventForms
• studyEventSchedules: array studyEventSchedules
• studyVersions: array studyVersions
• studyVersionsHistories: array studyVersionsHistories
• titrationExceptions: array titrationExceptions
• titrationKits: array titrationKits
• treatmentArms: array treatmentArms
• validationRules: array validationRules
• visits: array visits

{
    "type":"object",
    "properties":{
        "studyVersions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStudyVersionsDto"
            }
        },
        "dataViews":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubDataViewsDto"
            }
        },
        "formItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubFormItemsDto"
            }
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubVisitDto"
            }
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubKitsDto"
            }
        },
        "titrationKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubTitrationKitsDto"
            }
        },
        "titrationExceptions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubTitrationExceptionsDto"
            }
        },
        "treatmentArms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubTreatmentArmsDto"
            }
        },
        "extendedProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubExtendedPropertiesDto"
            }
        },
        "randomizations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubRandomizationDto"
            }
        },
        "randArmRatios":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubRandArmRatiosDto"
            }
        },
        "stratum":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStratumDto"
            }
        },
        "randStratumFactors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubRandStratumFactorsDto"
            }
        },
        "cohorts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubCohortDto"
            }
        },
        "studyEventSchedules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStudyEventScheduleDto"
            }
        },
        "studyEventForms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStudyeventFormDto"
            }
        },
        "dosingCalculations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubDosingCalculationDto"
            }
        },
        "armKitVisits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubArmKitVisitDto"
            }
        },
        "randCohortFactors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubRandCohortFactorDto"
            }
        },
        "stringResources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStringResourcesDto"
            }
        },
        "codeLists":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubCodeListsDto"
            }
        },
        "codeListItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubCodeListItemsDto"
            }
        },
        "studyVersionsHistories":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStudyVersionsHistoryDto"
            }
        },
        "branches":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubVisitBranchDto"
            }
        },
        "advanceDosingGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubAdvanceDosingGroupDto"
            }
        },
        "advanceDosingGroupCriterias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubAdvanceDosingGroupCriteriaDto"
            }
        },
        "advanceDosingGroupKitSettings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubAdvanceDosingGroupKitSettingDto"
            }
        },
        "validationRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubValidationRulesDto"
            }
        }
    }
}

Nested Schema : advanceDosingGroupCriterias

Type: array

Show Source

• Array of: object DatahubAdvanceDosingGroupCriteriaDto

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

Nested Schema : advanceDosingGroupKitSettings

Type: array

Show Source

• Array of: object DatahubAdvanceDosingGroupKitSettingDto

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

Nested Schema : advanceDosingGroups

Type: array

Show Source

• Array of: object DatahubAdvanceDosingGroupDto

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

Nested Schema : armKitVisits

Type: array

Show Source

• Array of: object DatahubArmKitVisitDto

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

Nested Schema : branches

Type: array

Show Source

• Array of: object DatahubVisitBranchDto

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

Nested Schema : codeListItems

Type: array

Show Source

• Array of: object DatahubCodeListItemsDto

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

Nested Schema : codeLists

Type: array

Show Source

• Array of: object DatahubCodeListsDto

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

Nested Schema : cohorts

Type: array

Show Source

• Array of: object DatahubCohortDto

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

Nested Schema : dataViews

Type: array

Show Source

• Array of: object DatahubDataViewsDto

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

Nested Schema : dosingCalculations

Type: array

Show Source

• Array of: object DatahubDosingCalculationDto

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

Nested Schema : extendedProperties

Type: array

Show Source

• Array of: object DatahubExtendedPropertiesDto

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

Nested Schema : formItems

Type: array

Show Source

• Array of: object DatahubFormItemsDto

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

Nested Schema : kits

Type: array

Show Source

• Array of: object DatahubKitsDto

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

Nested Schema : randArmRatios

Type: array

Show Source

• Array of: object DatahubRandArmRatiosDto

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

Nested Schema : randCohortFactors

Type: array

Show Source

• Array of: object DatahubRandCohortFactorDto

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

Nested Schema : randomizations

Type: array

Show Source

• Array of: object DatahubRandomizationDto

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

Nested Schema : randStratumFactors

Type: array

Show Source

• Array of: object DatahubRandStratumFactorsDto

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

Nested Schema : stratum

Type: array

Show Source

• Array of: object DatahubStratumDto

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

Nested Schema : stringResources

Type: array

Show Source

• Array of: object DatahubStringResourcesDto

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

Nested Schema : studyEventForms

Type: array

Show Source

• Array of: object DatahubStudyeventFormDto

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

Nested Schema : studyEventSchedules

Type: array

Show Source

• Array of: object DatahubStudyEventScheduleDto

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

Nested Schema : studyVersions

Type: array

Show Source

• Array of: object DatahubStudyVersionsDto

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

Nested Schema : studyVersionsHistories

Type: array

Show Source

• Array of: object DatahubStudyVersionsHistoryDto

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

Nested Schema : titrationExceptions

Type: array

Show Source

• Array of: object DatahubTitrationExceptionsDto

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

Nested Schema : titrationKits

Type: array

Show Source

• Array of: object DatahubTitrationKitsDto

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

Nested Schema : treatmentArms

Type: array

Show Source

• Array of: object DatahubTreatmentArmsDto

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

Nested Schema : validationRules

Type: array

Show Source

• Array of: object DatahubValidationRulesDto

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

Nested Schema : visits

Type: array

Show Source

• Array of: object DatahubVisitDto

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

Nested Schema : DatahubAdvanceDosingGroupCriteriaDto

Type: object

Show Source

• choiceAnswer: string
• comment: string
• criteriaType: string
• formId: string (uuid)
• groupId: string (uuid)
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• questionId: string (uuid)
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• variableDate: string (date-time)
• variableId: string (uuid)
• variableTimePeriod: string
• variableValues: string
• versionEnd: string (date-time)
• versionStart: string (date-time)
• visitId: string (uuid)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "groupId":{
            "type":"string",
            "format":"uuid"
        },
        "criteriaType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "questionId":{
            "type":"string",
            "format":"uuid"
        },
        "variableId":{
            "type":"string",
            "format":"uuid"
        },
        "choiceAnswer":{
            "type":"string"
        },
        "variableTimePeriod":{
            "type":"string"
        },
        "variableDate":{
            "type":"string",
            "format":"date-time"
        },
        "variableValues":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubAdvanceDosingGroupKitSettingDto

Type: object

Show Source

• comment: string
• dosingId: string (uuid)
• groupId: string (uuid)
• id: string (uuid)
• kitId: string (uuid)
• objectVersionNumber: number
• operationType: string
• quantity: integer (int64)
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "groupId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "quantity":{
            "type":"integer",
            "format":"int64"
        },
        "dosingId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubAdvanceDosingGroupDto

Type: object

Show Source

• comment: string
• groupName: string
• id: string (uuid)
• instructions: string
• kitId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "groupName":{
            "type":"string"
        },
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "instructions":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubArmKitVisitDto

Type: object

Show Source

• allowTitration: integer (int64)
• armId: string (uuid)
• comment: string
• componentSeq: integer (int64)
• dosingId: string (uuid)
• id: string (uuid)
• kitId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• titrationKitId: string (uuid)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• visitDispensed: integer (int64)
• visitDispenseOutsideWindow: integer (int64)
• visitDnd: integer (int64)
• visitId: string (uuid)
• visitQuantity: integer (int64)

{
    "type":"object",
    "properties":{
        "armId":{
            "type":"string",
            "format":"uuid"
        },
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "componentSeq":{
            "type":"integer",
            "format":"int64"
        },
        "studyVersion":{
            "type":"string"
        },
        "visitDispensed":{
            "type":"integer",
            "format":"int64"
        },
        "visitDnd":{
            "type":"integer",
            "format":"int64"
        },
        "visitQuantity":{
            "type":"integer",
            "format":"int64"
        },
        "visitDispenseOutsideWindow":{
            "type":"integer",
            "format":"int64"
        },
        "dosingId":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "titrationKitId":{
            "type":"string",
            "format":"uuid"
        },
        "allowTitration":{
            "type":"integer",
            "format":"int64"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubVisitBranchDto

Type: object

Show Source

• branchId: string (uuid)
• branchIndex: integer (int32)
• branchTier: integer (int32)
• comment: string
• cycleCount: number
• id: string (uuid)
• isCycle: integer (int32)
• isRestartCycle: integer (int64)
• objectVersionNumber: number
• operationType: string
• reason: string
• refname: string
• shortName: string
• softwareVersionNumber: number
• startCycle: integer (int32)
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "refname":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "isCycle":{
            "type":"integer",
            "format":"int32"
        },
        "cycleCount":{
            "type":"number"
        },
        "branchTier":{
            "type":"integer",
            "format":"int32"
        },
        "branchIndex":{
            "type":"integer",
            "format":"int32"
        },
        "startCycle":{
            "type":"integer",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"integer",
            "format":"int64"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubCodeListItemsDto

Type: object

Show Source

• clCode: string
• clValue: string
• code: string
• codeListId: string (uuid)
• codeListType: string
• comment: string
• description: string
• id: string (uuid)
• itemSeq: number
• objectVersionNumber: number
• operationType: string
• reason: string
• refName: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• valueRefId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "codeListId":{
            "type":"string",
            "format":"uuid"
        },
        "refName":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "itemSeq":{
            "type":"number"
        },
        "valueRefId":{
            "type":"string",
            "format":"uuid"
        },
        "codeListType":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "clCode":{
            "type":"string"
        },
        "clValue":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubCodeListsDto

Type: object

Show Source

• codeListType: string
• comment: string
• description: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• refName: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "refName":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "codeListType":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubCohortDto

Type: object

Show Source

• cohortDescription: string
• cohortRefname: string
• cohortSeq: number
• cohortTitle: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• randId: string (uuid)
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "randId":{
            "type":"string",
            "format":"uuid"
        },
        "cohortRefname":{
            "type":"string"
        },
        "cohortTitle":{
            "type":"string"
        },
        "cohortDescription":{
            "type":"string"
        },
        "cohortSeq":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubDataViewsDto

Type: object

Show Source

• allowMultipleInstances: integer (int64)
• comment: string
• description: string
• dynamic: integer (int32)
• formCategory: string
• formSubCategory: string
• formType: integer (int32)
• id: string (uuid)
• includeInSafetyCaseData: integer (int32)
• isNested: integer (int64)
• isRuleCopied: integer (int64)
• isShared: integer (int64)
• objectVersionNumber: number
• operationType: string
• reason: string
• refName: string
• repeating: integer (int64)
• repeatingInstanceId: string (uuid)
• shortTitleRefId: string (uuid)
• softwareVersionNumber: number
• sourceDataviewId: string (uuid)
• sourceStudyId: string (uuid)
• sourceStudyVersion: string
• sourceVersionStart: string (date-time)
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "refName":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "repeatingInstanceId":{
            "type":"string",
            "format":"uuid"
        },
        "isNested":{
            "type":"integer",
            "format":"int64"
        },
        "isShared":{
            "type":"integer",
            "format":"int64"
        },
        "shortTitleRefId":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "repeating":{
            "type":"integer",
            "format":"int64"
        },
        "dynamic":{
            "type":"integer",
            "format":"int32"
        },
        "sourceDataviewId":{
            "type":"string",
            "format":"uuid"
        },
        "sourceStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string"
        },
        "sourceVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "isRuleCopied":{
            "type":"integer",
            "format":"int64"
        },
        "formType":{
            "type":"integer",
            "format":"int32"
        },
        "includeInSafetyCaseData":{
            "type":"integer",
            "format":"int32"
        },
        "formCategory":{
            "type":"string"
        },
        "formSubCategory":{
            "type":"string"
        },
        "allowMultipleInstances":{
            "type":"integer",
            "format":"int64"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubDosingCalculationDto

Type: object

Show Source

• comment: string
• dosingFrequency: string
• dosingLeftOverUnits: number
• dosingName: string
• dosingPrecision: number
• dosingRoundUp: number
• formId: string (uuid)
• id: string (uuid)
• itemId: string (uuid)
• kitId: string (uuid)
• measurementKitValue: number
• measurementSubjectValue: number
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• visitId: string (uuid)
• visitType: string

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "dosingName":{
            "type":"string"
        },
        "visitType":{
            "type":"string"
        },
        "dosingPrecision":{
            "type":"number"
        },
        "dosingRoundUp":{
            "type":"number"
        },
        "dosingFrequency":{
            "type":"string"
        },
        "dosingLeftOverUnits":{
            "type":"number"
        },
        "measurementKitValue":{
            "type":"number"
        },
        "measurementSubjectValue":{
            "type":"number"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubExtendedPropertiesDto

Type: object

Show Source

• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• parentObjectId: string (uuid)
• parentObjectLevel: string
• propertyName: string
• propertySource: string
• propertyType: string
• propertyValue: string
• reason: string
• responseMapJson: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "parentObjectId":{
            "type":"string",
            "format":"uuid"
        },
        "parentObjectLevel":{
            "type":"string"
        },
        "propertyType":{
            "type":"string"
        },
        "propertySource":{
            "type":"string"
        },
        "propertyName":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "responseMapJson":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubFormItemsDto

Type: object

Show Source

• allowAdditionalRows: integer (int64)
• allowFutureDate: integer (int32)
• applyChangeToVersion: string
• choiceType: string
• clLabNormalsTag: string
• codeListId: string (uuid)
• codelistItems: string
• columnCnt: integer (int64)
• columnLayout: string (uuid)
• comment: string
• componentSeq: integer (int32)
• dataViewId: string (uuid)
• dtFormat: string
• dtRequired: string
• dynamic: integer (int32)
• ehrMapping: array ehrMapping
• excludedLocations: string
• existingDataCodeName: string
• existingDataCodeValue: string
• formula: string
• groupId: string (uuid)
• groupItemSeq: integer (int32)
• hidden: integer (int64)
• hintId: string (uuid)
• id: string (uuid)
• ifThenFlag: integer (int64)
• instructionalText: string
• itemDescription: string
• itemRules: string
• itemTags: string
• itemTitle: string
• itemType: string
• labNormalsTag: string
• length: integer (int32)
• objectVersionNumber: number
• objectVersionsId: string (uuid)
• operationType: string
• paneSize: integer (int64)
• precision: integer (int32)
• questionId: string (uuid)
• readOnly: integer (int64)
• reason: string
• refname: string
• required: integer (int32)
• sasLabelId: string (uuid)
• sasVariable: string
• sdv: integer (int32)
• smartItemId: string (uuid)
• softwareVersionNumber: number
• source: string
• studyId: string (uuid)
• studyVersion: string
• unitOfMeasurement: string
• unitType: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "dataViewId":{
            "type":"string",
            "format":"uuid"
        },
        "itemType":{
            "type":"string"
        },
        "refname":{
            "type":"string"
        },
        "itemTitle":{
            "type":"string"
        },
        "itemDescription":{
            "type":"string"
        },
        "questionId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionsId":{
            "type":"string",
            "format":"uuid"
        },
        "sasVariable":{
            "type":"string"
        },
        "sasLabelId":{
            "type":"string",
            "format":"uuid"
        },
        "hintId":{
            "type":"string",
            "format":"uuid"
        },
        "required":{
            "type":"integer",
            "format":"int32"
        },
        "sdv":{
            "type":"integer",
            "format":"int32"
        },
        "itemRules":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "unitType":{
            "type":"string"
        },
        "unitOfMeasurement":{
            "type":"string"
        },
        "formula":{
            "type":"string"
        },
        "dtFormat":{
            "type":"string"
        },
        "dtRequired":{
            "type":"string"
        },
        "choiceType":{
            "type":"string"
        },
        "columnLayout":{
            "type":"string",
            "format":"uuid"
        },
        "codelistItems":{
            "type":"string"
        },
        "codeListId":{
            "type":"string",
            "format":"uuid"
        },
        "smartItemId":{
            "type":"string",
            "format":"uuid"
        },
        "columnCnt":{
            "type":"integer",
            "format":"int64"
        },
        "paneSize":{
            "type":"integer",
            "format":"int64"
        },
        "ifThenFlag":{
            "type":"integer",
            "format":"int64"
        },
        "excludedLocations":{
            "type":"string"
        },
        "itemTags":{
            "type":"string"
        },
        "componentSeq":{
            "type":"integer",
            "format":"int32"
        },
        "hidden":{
            "type":"integer",
            "format":"int64"
        },
        "readOnly":{
            "type":"integer",
            "format":"int64"
        },
        "groupId":{
            "type":"string",
            "format":"uuid"
        },
        "groupItemSeq":{
            "type":"integer",
            "format":"int32"
        },
        "dynamic":{
            "type":"integer",
            "format":"int32"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "allowAdditionalRows":{
            "type":"integer",
            "format":"int64"
        },
        "labNormalsTag":{
            "type":"string"
        },
        "clLabNormalsTag":{
            "type":"string"
        },
        "applyChangeToVersion":{
            "type":"string"
        },
        "instructionalText":{
            "type":"string"
        },
        "allowFutureDate":{
            "type":"integer",
            "format":"int32"
        },
        "existingDataCodeName":{
            "type":"string"
        },
        "existingDataCodeValue":{
            "type":"string"
        },
        "ehrMapping":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtoV9"
            }
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : ehrMapping

Type: array

Show Source

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

  Form Item Advanced Property

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

Nested Schema : From Item Advanced Property v9.0

Type: object

Title: From Item Advanced Property v9.0

Form Item Advanced Property

Show Source

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

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

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

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

Nested Schema : rules

Type: array

Show Source

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

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v9.0

Type: object

Title: From Item Advanced Property Rule v9.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 v9.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 : DatahubKitsDto

Type: object

Show Source

• advancedDosing: integer (int32)
• bufferdays: integer (int64)
• calculatingDoses: integer (int64)
• comment: string
• controlSubstance: integer (int32)
• deviceConnection: string
• deviceType: string
• dispenseOnHighestDose: integer (int64)
• dispenseOnHighestDoseMsgId: string (uuid)
• dispenseOnLowestDose: integer (int64)
• dispenseOnLowestDoseMsgId: string (uuid)
• dispenseOutsideWindow: integer (int64)
• distributionSetting: string
• doseChangeUnschVisit: integer (int64)
• dosingFrequency: integer (int64)
• downTitrateDose: integer (int64)
• downTitrateDoseUnscheduled: integer (int64)
• hazardousMaterial: integer (int32)
• id: string (uuid)
• kitDescription: string
• kitRefName: string
• kitTitle: string
• libraryKitId: string (uuid)
• minShipUnits: integer (int64)
• objectVersionNumber: number
• operationType: string
• poolingId: string
• reason: string
• serialized: integer (int32)
• singleUnitDoseUnits: string
• singleUnitDoseValue: number (double)
• softwareVersionNumber: number
• storageSetting: string
• studyId: string (uuid)
• studyVersion: string
• timeBetweenDownDoseUnit: string
• timeBetweenDownDoseVal: integer (int64)
• timeBetweenUpDoseUnit: string
• timeBetweenUpDoseVal: integer (int64)
• titratingDoses: integer (int64)
• titrationKit: integer (int64)
• totalDose: integer (int64)
• totalDoseUnscheduled: integer (int64)
• trialSupplyType: string
• unitsPerKit: number
• upTitrateDose: integer (int64)
• upTitrateDoseUnscheduled: integer (int64)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "kitTitle":{
            "type":"string"
        },
        "kitRefName":{
            "type":"string"
        },
        "kitDescription":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "storageSetting":{
            "type":"string"
        },
        "distributionSetting":{
            "type":"string"
        },
        "trialSupplyType":{
            "type":"string"
        },
        "unitsPerKit":{
            "type":"number"
        },
        "minShipUnits":{
            "type":"integer",
            "format":"int64"
        },
        "bufferdays":{
            "type":"integer",
            "format":"int64"
        },
        "dispenseOutsideWindow":{
            "type":"integer",
            "format":"int64"
        },
        "calculatingDoses":{
            "type":"integer",
            "format":"int64"
        },
        "titratingDoses":{
            "type":"integer",
            "format":"int64"
        },
        "singleUnitDoseValue":{
            "type":"number",
            "format":"double"
        },
        "singleUnitDoseUnits":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "titrationKit":{
            "type":"integer",
            "format":"int64"
        },
        "dosingFrequency":{
            "type":"integer",
            "format":"int64"
        },
        "doseChangeUnschVisit":{
            "type":"integer",
            "format":"int64"
        },
        "totalDose":{
            "type":"integer",
            "format":"int64"
        },
        "upTitrateDose":{
            "type":"integer",
            "format":"int64"
        },
        "downTitrateDose":{
            "type":"integer",
            "format":"int64"
        },
        "totalDoseUnscheduled":{
            "type":"integer",
            "format":"int64"
        },
        "upTitrateDoseUnscheduled":{
            "type":"integer",
            "format":"int64"
        },
        "downTitrateDoseUnscheduled":{
            "type":"integer",
            "format":"int64"
        },
        "timeBetweenUpDoseUnit":{
            "type":"string"
        },
        "timeBetweenUpDoseVal":{
            "type":"integer",
            "format":"int64"
        },
        "timeBetweenDownDoseUnit":{
            "type":"string"
        },
        "timeBetweenDownDoseVal":{
            "type":"integer",
            "format":"int64"
        },
        "dispenseOnHighestDose":{
            "type":"integer",
            "format":"int64"
        },
        "dispenseOnHighestDoseMsgId":{
            "type":"string",
            "format":"uuid"
        },
        "dispenseOnLowestDose":{
            "type":"integer",
            "format":"int64"
        },
        "dispenseOnLowestDoseMsgId":{
            "type":"string",
            "format":"uuid"
        },
        "deviceType":{
            "type":"string"
        },
        "deviceConnection":{
            "type":"string"
        },
        "advancedDosing":{
            "type":"integer",
            "format":"int32"
        },
        "libraryKitId":{
            "type":"string",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string"
        },
        "serialized":{
            "type":"integer",
            "format":"int32"
        },
        "hazardousMaterial":{
            "type":"integer",
            "format":"int32"
        },
        "controlSubstance":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubRandArmRatiosDto

Type: object

Show Source

• armId: string (uuid)
• armRatio: integer (int32)
• armTitle: string
• comment: string
• componentSeq: integer (int64)
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• optionalId: string (uuid)
• optionalType: string
• randArms: string
• randId: string (uuid)
• reason: string
• softwareVersionNumber: number
• stratumTitle: string
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "randId":{
            "type":"string",
            "format":"uuid"
        },
        "armId":{
            "type":"string",
            "format":"uuid"
        },
        "optionalId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "componentSeq":{
            "type":"integer",
            "format":"int64"
        },
        "armRatio":{
            "type":"integer",
            "format":"int32"
        },
        "optionalType":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersion":{
            "type":"string"
        },
        "armTitle":{
            "type":"string"
        },
        "stratumTitle":{
            "type":"string"
        },
        "randArms":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubRandCohortFactorDto

Type: object

Show Source

• codelistId: string (uuid)
• codelistitemId: string (uuid)
• cohortId: string (uuid)
• cohortItems: string
• cohortSeq: number
• cohortTitle: string
• cohortType: string
• comment: string
• dataviewId: string (uuid)
• dataviewTitle: string
• factorCode: string
• factorMax: number (double)
• factorMin: number (double)
• factorRange: string
• factorSeq: number
• factorValue: string
• itemId: string (uuid)
• itemRules: string
• itemTitle: string
• itemType: string
• objectVersionNumber: number
• operationType: string
• question: string
• randCohortFactorId: string (uuid)
• randId: string (uuid)
• randTitle: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "randCohortFactorId":{
            "type":"string",
            "format":"uuid"
        },
        "randId":{
            "type":"string",
            "format":"uuid"
        },
        "cohortId":{
            "type":"string",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "factorSeq":{
            "type":"number"
        },
        "codelistitemId":{
            "type":"string",
            "format":"uuid"
        },
        "factorCode":{
            "type":"string"
        },
        "factorMax":{
            "type":"number",
            "format":"double"
        },
        "factorMin":{
            "type":"number",
            "format":"double"
        },
        "factorRange":{
            "type":"string"
        },
        "factorValue":{
            "type":"string"
        },
        "randTitle":{
            "type":"string"
        },
        "cohortType":{
            "type":"string"
        },
        "cohortTitle":{
            "type":"string"
        },
        "cohortSeq":{
            "type":"number"
        },
        "dataviewId":{
            "type":"string",
            "format":"uuid"
        },
        "dataviewTitle":{
            "type":"string"
        },
        "itemTitle":{
            "type":"string"
        },
        "question":{
            "type":"string"
        },
        "itemType":{
            "type":"string"
        },
        "codelistId":{
            "type":"string",
            "format":"uuid"
        },
        "itemRules":{
            "type":"string"
        },
        "cohortItems":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : DatahubRandomizationDto

Type: object

Show Source

• algorithmtype: string
• allowOutsideWindow: integer (int32)
• assignNewRandnumbs: integer (int32)
• assignskippedrandnumbs: integer (int32)
• cohorttype: string
• comment: string
• id: string (uuid)
• limitscountearlyterm: integer (int32)
• objectVersionNumber: number
• operationType: string
• randDescription: string
• randomizeoutofkits: integer (int32)
• randRefname: string
• randTitle: string
• randType: string
• reason: string
• reRandomization: integer (int32)
• showarmlabels: integer (int32)
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• studyVersionStart: string (date-time)
• treatmentArms: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "algorithmtype":{
            "type":"string"
        },
        "assignskippedrandnumbs":{
            "type":"integer",
            "format":"int32"
        },
        "cohorttype":{
            "type":"string"
        },
        "limitscountearlyterm":{
            "type":"integer",
            "format":"int32"
        },
        "operationType":{
            "type":"string"
        },
        "randDescription":{
            "type":"string"
        },
        "randRefname":{
            "type":"string"
        },
        "randTitle":{
            "type":"string"
        },
        "randomizeoutofkits":{
            "type":"integer",
            "format":"int32"
        },
        "showarmlabels":{
            "type":"integer",
            "format":"int32"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersion":{
            "type":"string"
        },
        "randType":{
            "type":"string"
        },
        "reRandomization":{
            "type":"integer",
            "format":"int32"
        },
        "treatmentArms":{
            "type":"string"
        },
        "assignNewRandnumbs":{
            "type":"integer",
            "format":"int32"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "allowOutsideWindow":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubRandStratumFactorsDto

Type: object

Show Source

• codelistitemId: string (uuid)
• comment: string
• factorCode: string
• factorMax: number (double)
• factorMin: number (double)
• factorSeq: number
• groupId: string (uuid)
• groupName: string
• id: string (uuid)
• itemId: string (uuid)
• objectVersionNumber: number
• operationType: string
• randId: string (uuid)
• reason: string
• softwareVersionNumber: number
• stratumId: string (uuid)
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "stratumId":{
            "type":"string",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "factorSeq":{
            "type":"number"
        },
        "codelistitemId":{
            "type":"string",
            "format":"uuid"
        },
        "factorCode":{
            "type":"string"
        },
        "factorMax":{
            "type":"number",
            "format":"double"
        },
        "factorMin":{
            "type":"number",
            "format":"double"
        },
        "operationType":{
            "type":"string"
        },
        "randId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "groupName":{
            "type":"string"
        },
        "groupId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStratumDto

Type: object

Show Source

• comment: string
• description: string
• id: string (uuid)
• objectId: string (uuid)
• objectType: string
• objectVersionNumber: number
• operationType: string
• randId: string (uuid)
• randomizationType: string
• reason: string
• refname: string
• softwareVersionNumber: number
• stratumSeq: number
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• weight: integer (int32)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "randId":{
            "type":"string",
            "format":"uuid"
        },
        "refname":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "stratumSeq":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "weight":{
            "type":"integer",
            "format":"int32"
        },
        "randomizationType":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        },
        "objectId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStringResourcesDto

Type: object

Show Source

• columnNameWU: string
• comment: string
• id: string (uuid)
• locale: string
• objectIdWU: string (uuid)
• objectTypeWU: string
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• strValue: string
• studyId: string (uuid)
• studyVersion: string
• textIX: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "type":"string"
        },
        "strValue":{
            "type":"string"
        },
        "textIX":{
            "type":"number"
        },
        "objectTypeWU":{
            "type":"string"
        },
        "objectIdWU":{
            "type":"string",
            "format":"uuid"
        },
        "columnNameWU":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStudyeventFormDto

Type: object

Show Source

• comment: string
• componentSeq: integer (int32)
• componentStart: string (date-time)
• formId: string (uuid)
• formRefName: string
• formStart: string (date-time)
• formTitle: string
• id: string (uuid)
• isDynamic: integer (int32)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyeventEnd: string (date-time)
• studyEventRefName: string
• studyeventStart: string (date-time)
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• visitId: string (uuid)
• visitTitle: string

{
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "componentStart":{
            "type":"string",
            "format":"date-time"
        },
        "componentSeq":{
            "type":"integer",
            "format":"int32"
        },
        "visitTitle":{
            "type":"string"
        },
        "formTitle":{
            "type":"string"
        },
        "studyeventStart":{
            "type":"string",
            "format":"date-time"
        },
        "formStart":{
            "type":"string",
            "format":"date-time"
        },
        "studyeventEnd":{
            "type":"string",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "studyEventRefName":{
            "type":"string"
        },
        "formRefName":{
            "type":"string"
        },
        "isDynamic":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStudyEventScheduleDto

Type: object

Show Source

• comment: string
• delayDays: integer (int32)
• delayHours: integer (int32)
• delayWindowAfterDays: integer (int32)
• delayWindowAfterHours: integer (int32)
• delayWindowBeforeDays: integer (int32)
• delayWindowBeforeHours: integer (int32)
• delayWindowHardstop: integer (int32)
• delayWindowVisitApproval: integer (int32)
• fromVisitId: string (uuid)
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• outOfWindowAlert: string
• reason: string
• sequence: integer (int32)
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• visitId: string (uuid)
• visitSequence: integer (int32)

{
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "fromVisitId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "sequence":{
            "type":"integer",
            "format":"int32"
        },
        "delayDays":{
            "type":"integer",
            "format":"int32"
        },
        "delayHours":{
            "type":"integer",
            "format":"int32"
        },
        "delayWindowBeforeDays":{
            "type":"integer",
            "format":"int32"
        },
        "delayWindowBeforeHours":{
            "type":"integer",
            "format":"int32"
        },
        "delayWindowAfterDays":{
            "type":"integer",
            "format":"int32"
        },
        "delayWindowAfterHours":{
            "type":"integer",
            "format":"int32"
        },
        "delayWindowHardstop":{
            "type":"integer",
            "format":"int32"
        },
        "delayWindowVisitApproval":{
            "type":"integer",
            "format":"int32"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "visitSequence":{
            "type":"integer",
            "format":"int32"
        },
        "outOfWindowAlert":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStudyVersionsDto

Type: object

Show Source

• companyValue: string
• defaultLocale: string
• description: string
• objectVersionNumber: number
• operationType: string
• revisionTimestamp: string (date-time)
• softwareVersionNumber: number
• status: string
• studyId: string (uuid)
• studyRefname: string
• studyTitle: string
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "studyRefname":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "defaultLocale":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "revisionTimestamp":{
            "type":"string",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "status":{
            "type":"string"
        },
        "studyTitle":{
            "type":"string"
        },
        "companyValue":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStudyVersionsHistoryDto

Type: object

Show Source

• blindingType: string
• contractCode: string
• copyStudyId: string (uuid)
• copyStudyVersion: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• previousState: string
• previousStatus: string
• softwareVersionNumber: number
• studyDescription: string
• studyId: string (uuid)
• studyPhase: string
• studyRefname: string
• studyState: string
• studyTitle: string
• studyVersion: string
• therapeuticArea: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionHistory: string
• versionStart: string (date-time)
• versionStatus: string
• versionTitle: string
• versionType: string

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "previousState":{
            "type":"string"
        },
        "studyRefname":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionType":{
            "type":"string"
        },
        "versionTitle":{
            "type":"string"
        },
        "versionStatus":{
            "type":"string"
        },
        "previousStatus":{
            "type":"string"
        },
        "contractCode":{
            "type":"string"
        },
        "copyStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "copyStudyVersion":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "studyDescription":{
            "type":"string"
        },
        "studyPhase":{
            "type":"string"
        },
        "studyState":{
            "type":"string"
        },
        "studyTitle":{
            "type":"string"
        },
        "therapeuticArea":{
            "type":"string"
        },
        "versionHistory":{
            "type":"string"
        },
        "blindingType":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubTitrationExceptionsDto

Type: object

Show Source

• comment: string
• endingDoseJson: string
• exceptionType: string
• id: string (uuid)
• kitId: string (uuid)
• minTimeBetweenDose: integer (int64)
• minTimeBetweenDoseUnit: string
• objectVersionNumber: number
• operationType: string
• reason: string
• sequence: integer (int64)
• softwareVersionNumber: number
• startingDoseJson: string
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "startingDoseJson":{
            "type":"string"
        },
        "endingDoseJson":{
            "type":"string"
        },
        "sequence":{
            "type":"integer",
            "format":"int64"
        },
        "minTimeBetweenDose":{
            "type":"integer",
            "format":"int64"
        },
        "minTimeBetweenDoseUnit":{
            "type":"string"
        },
        "exceptionType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubTitrationKitsDto

Type: object

Show Source

• comment: string
• downTitrationKitJson: string
• id: string (uuid)
• maintainTitrationKitJson: string
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• titrationKitId: string (uuid)
• titrationKitJson: string
• titrationKitLabelId: string (uuid)
• titrationKitSeq: integer (int64)
• upTitrationKitJson: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "titrationKitId":{
            "type":"string",
            "format":"uuid"
        },
        "titrationKitLabelId":{
            "type":"string",
            "format":"uuid"
        },
        "titrationKitJson":{
            "type":"string"
        },
        "titrationKitSeq":{
            "type":"integer",
            "format":"int64"
        },
        "downTitrationKitJson":{
            "type":"string"
        },
        "maintainTitrationKitJson":{
            "type":"string"
        },
        "upTitrationKitJson":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubTreatmentArmsDto

Type: object

Show Source

• armDescription: string
• armRefName: string
• armShortName: string
• armTitle: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "armRefName":{
            "type":"string"
        },
        "armTitle":{
            "type":"string"
        },
        "armDescription":{
            "type":"string"
        },
        "armShortName":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubValidationRulesDto

Type: object

Show Source

• comment: string
• id: string (uuid)
• lowerValue: string
• objectVersionNumber: number
• operationType: string
• parentObjectId: string (uuid)
• parentObjectLevel: string
• reason: string
• ruleType: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• upperValue: string
• userId: string (uuid)
• value: string
• valueList: string
• valueType: string
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "parentObjectId":{
            "type":"string",
            "format":"uuid"
        },
        "parentObjectLevel":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "ruleType":{
            "type":"string"
        },
        "valueType":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "valueList":{
            "type":"string"
        },
        "lowerValue":{
            "type":"string"
        },
        "upperValue":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubVisitDto

Type: object

Show Source

• branchId: string (uuid)
• comment: string
• description: string
• endVisitId: string (uuid)
• eventTitleRefId: string (uuid)
• eventType: string
• id: string (uuid)
• lastRequired: integer (int32)
• layoutHints: string
• objectVersionNumber: number
• operationType: string
• orderScore: integer (int32)
• randomizationId: string (uuid)
• reason: string
• refname: string
• repeating: integer (int32)
• repeatingInstanceId: string (uuid)
• repeatLimit: integer (int32)
• required: integer (int32)
• schedSeq: integer (int32)
• scheduled: integer (int32)
• shortName: string
• shortTitleRefId: string (uuid)
• softwareVersionNumber: number
• source: string
• startVisitId: string (uuid)
• studyId: string (uuid)
• studyVersion: string
• timeLine: integer
• title: string
• typeOfEvent: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• visitSeq: integer (int32)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "refname":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "typeOfEvent":{
            "type":"string"
        },
        "visitSeq":{
            "type":"integer",
            "format":"int32"
        },
        "required":{
            "type":"integer",
            "format":"int32"
        },
        "randomizationId":{
            "type":"string",
            "format":"uuid"
        },
        "lastRequired":{
            "type":"integer",
            "format":"int32"
        },
        "repeating":{
            "type":"integer",
            "format":"int32"
        },
        "repeatLimit":{
            "type":"integer",
            "format":"int32"
        },
        "repeatingInstanceId":{
            "type":"string",
            "format":"uuid"
        },
        "eventTitleRefId":{
            "type":"string",
            "format":"uuid"
        },
        "shortTitleRefId":{
            "type":"string",
            "format":"uuid"
        },
        "layoutHints":{
            "type":"string"
        },
        "startVisitId":{
            "type":"string",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "orderScore":{
            "type":"integer",
            "format":"int32"
        },
        "schedSeq":{
            "type":"integer",
            "format":"int32"
        },
        "scheduled":{
            "type":"integer",
            "format":"int32"
        },
        "source":{
            "type":"string"
        },
        "branchId":{
            "type":"string",
            "format":"uuid"
        },
        "timeLine":{
            "type":"integer"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

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