Jump to

• Request
• Response

Get the metadata of specified visits by study ID and study version

post

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

Retrieves metadata for specified visits in different study versions.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

• asofdate(required): string
  Format for the study metadata

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyVersionVisitDtoV2

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

Nested Schema : StudyVersionVisitDtoV2

Type: object

Show Source

• studyId: string (uuid)
• studyTitle: string
• studyVersion: string
• visitId: string (uuid)
  Visit GUID

{
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "studyTitle":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ODM

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

Nested Schema : ODM

Type: object

Show Source

• AdminData: array AdminData
• Archival: string
  Allowed Values: [ "YES" ]
• AsOfDateTime: string
• Association: array Association
• ClinicalData: array ClinicalData
• CreationDateTime: string
• Description: string
• FileOID: string
• FileType: string
  Allowed Values: [ "Snapshot", "Transactional" ]
• Granularity: string
  Allowed Values: [ "Metadata", "AdminData", "ReferenceData", "AllClinicalData", "SingleSite", "SingleSubject" ]
• ID: string
• ODMVersion: string
• Originator: string
• PriorFileOID: string
• ReferenceData: array ReferenceData
• Signature: array Signature
• SourceSystem: string
• SourceSystemVersion: string
• Study: array Study

{
    "type":"object",
    "properties":{
        "Study":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Study"
            }
        },
        "AdminData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdminData"
            }
        },
        "ReferenceData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceData"
            }
        },
        "ClinicalData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ClinicalData"
            }
        },
        "Association":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Association"
            }
        },
        "Signature":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SignatureType"
            }
        },
        "Description":{
            "type":"string"
        },
        "FileType":{
            "type":"string",
            "enum":[
                "Snapshot",
                "Transactional"
            ]
        },
        "Granularity":{
            "type":"string",
            "enum":[
                "Metadata",
                "AdminData",
                "ReferenceData",
                "AllClinicalData",
                "SingleSite",
                "SingleSubject"
            ]
        },
        "Archival":{
            "type":"string",
            "enum":[
                "YES"
            ]
        },
        "FileOID":{
            "type":"string"
        },
        "CreationDateTime":{
            "type":"string"
        },
        "PriorFileOID":{
            "type":"string"
        },
        "AsOfDateTime":{
            "type":"string"
        },
        "Originator":{
            "type":"string"
        },
        "SourceSystem":{
            "type":"string"
        },
        "SourceSystemVersion":{
            "type":"string"
        },
        "ODMVersion":{
            "type":"string"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : AdminData

Type: array

Show Source

• Array of: object AdminData

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

Nested Schema : Association

Type: array

Show Source

• Array of: object Association

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

Nested Schema : ClinicalData

Type: array

Show Source

• Array of: object ClinicalData

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

Nested Schema : ReferenceData

Type: array

Show Source

• Array of: object ReferenceData

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

Nested Schema : Signature

Type: array

Show Source

• Array of: object SignatureType

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

Nested Schema : Study

Type: array

Show Source

• Array of: object Study

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

Nested Schema : AdminData

Type: object

Show Source

• Location: array Location
• SignatureDef: array SignatureDef
• StudyOID: string
• User: array User

{
    "type":"object",
    "properties":{
        "User":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/User"
            }
        },
        "Location":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Location"
            }
        },
        "SignatureDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SignatureDef"
            }
        },
        "StudyOID":{
            "type":"string"
        }
    }
}

Nested Schema : Location

Type: array

Show Source

• Array of: object Location

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

Nested Schema : SignatureDef

Type: array

Show Source

• Array of: object SignatureDef

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

Nested Schema : User

Type: array

Show Source

• Array of: object User

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

Nested Schema : Location

Type: object

Show Source

• LocationType: string
  Allowed Values: [ "SPONSOR", "SITE", "CRO", "LAB", "OTHER" ]
• MetaDataVersionRef: array MetaDataVersionRef
• Name: string
• OID: string

{
    "type":"object",
    "properties":{
        "MetaDataVersionRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetaDataVersionRef"
            }
        },
        "Name":{
            "type":"string"
        },
        "LocationType":{
            "type":"string",
            "enum":[
                "SPONSOR",
                "SITE",
                "CRO",
                "LAB",
                "OTHER"
            ]
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : MetaDataVersionRef

Type: array

Show Source

• Array of: object MetaDataVersionRef

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

Nested Schema : MetaDataVersionRef

Type: object

Show Source

• EffectiveDate: string
• EffectiveDateTime: string
• MetaDataVersionOID: string
• StudyOID: string

{
    "type":"object",
    "properties":{
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        },
        "EffectiveDate":{
            "type":"string"
        },
        "EffectiveDateTime":{
            "type":"string"
        }
    }
}

Nested Schema : SignatureDef

Type: object

Show Source

• Group: string
• LegalReason: object LegalReason
• Meaning: object Meaning
• OID: string
• Type: string

{
    "type":"object",
    "properties":{
        "Group":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Meaning":{
            "$ref":"#/components/schemas/Meaning"
        },
        "LegalReason":{
            "$ref":"#/components/schemas/LegalReason"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : LegalReason

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Meaning

Type: object

Show Source

• Text: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "Text":{
            "type":"string"
        }
    }
}

Nested Schema : User

Type: object

Show Source

• Address: array Address
• Certificate: array Certificate
• DisplayName: object DisplayName
• Email: array Email
• Fax: array Fax
• FirstName: object FirstName
• FullName: object FullName
• LastName: object LastName
• LocationRef: array LocationRef
• LoginName: object LoginName
• OID: string
• Organization: object Organization
• Pager: object Pager
• Phone: array Phone
• Picture: object Picture
• UserType: string
  Allowed Values: [ "SPONSOR", "INVESTIGATOR", "LAB", "OTHER" ]

{
    "type":"object",
    "properties":{
        "LoginName":{
            "$ref":"#/components/schemas/LoginName"
        },
        "DisplayName":{
            "$ref":"#/components/schemas/DisplayName"
        },
        "FullName":{
            "$ref":"#/components/schemas/FullName"
        },
        "FirstName":{
            "$ref":"#/components/schemas/FirstName"
        },
        "LastName":{
            "$ref":"#/components/schemas/LastName"
        },
        "Organization":{
            "$ref":"#/components/schemas/Organization"
        },
        "Address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "Email":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Email"
            }
        },
        "Picture":{
            "$ref":"#/components/schemas/Picture"
        },
        "Pager":{
            "$ref":"#/components/schemas/Pager"
        },
        "Fax":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Fax"
            }
        },
        "Phone":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Phone"
            }
        },
        "LocationRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocationRef"
            }
        },
        "Certificate":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Certificate"
            }
        },
        "UserType":{
            "type":"string",
            "enum":[
                "SPONSOR",
                "INVESTIGATOR",
                "LAB",
                "OTHER"
            ]
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Address

Type: array

Show Source

• Array of: object Address

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

Nested Schema : Certificate

Type: array

Show Source

• Array of: object Certificate

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

Nested Schema : DisplayName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Email

Type: array

Show Source

• Array of: object Email

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

Nested Schema : Fax

Type: array

Show Source

• Array of: object Fax

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

Nested Schema : FirstName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : FullName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : LastName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : LocationRef

Type: array

Show Source

• Array of: object LocationRef

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

Nested Schema : LoginName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Organization

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Pager

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Phone

Type: array

Show Source

• Array of: object Phone

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

Nested Schema : Picture

Type: object

Show Source

• ImageType: string
• PictureFileName: string

{
    "type":"object",
    "properties":{
        "PictureFileName":{
            "type":"string"
        },
        "ImageType":{
            "type":"string"
        }
    }
}

Nested Schema : Address

Type: object

Show Source

• City: object City
• Country: object Country
• OtherText: object OtherText
• PostalCode: object PostalCode
• StateProv: object StateProv
• StreetName: array StreetName

{
    "type":"object",
    "properties":{
        "StreetName":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StreetName"
            }
        },
        "City":{
            "$ref":"#/components/schemas/City"
        },
        "StateProv":{
            "$ref":"#/components/schemas/StateProv"
        },
        "Country":{
            "$ref":"#/components/schemas/Country"
        },
        "PostalCode":{
            "$ref":"#/components/schemas/PostalCode"
        },
        "OtherText":{
            "$ref":"#/components/schemas/OtherText"
        }
    }
}

Nested Schema : City

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Country

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : OtherText

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : PostalCode

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : StateProv

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : StreetName

Type: array

Show Source

• Array of: object StreetName

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

Nested Schema : StreetName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Certificate

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Email

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Fax

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : LocationRef

Type: object

Show Source

• LocationOID: string

{
    "type":"object",
    "properties":{
        "LocationOID":{
            "type":"string"
        }
    }
}

Nested Schema : Phone

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Association

Type: object

Show Source

• Content: array Content
• MetaDataVersionOID: string
• StudyOID: string

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    }
}

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : ClinicalData

Type: object

Show Source

• Annotations: array Annotations
• AuditRecords: array AuditRecords
• MetaDataVersionOID: string
• Signatures: array Signatures
• StudyOID: string
• SubjectData: array SubjectData

{
    "type":"object",
    "properties":{
        "SubjectData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectData"
            }
        },
        "AuditRecords":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecords"
            }
        },
        "Signatures":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signatures"
            }
        },
        "Annotations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotations"
            }
        },
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    }
}

Nested Schema : Annotations

Type: array

Show Source

• Array of: object Annotations

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

Nested Schema : AuditRecords

Type: array

Show Source

• Array of: object AuditRecords

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

Nested Schema : Signatures

Type: array

Show Source

• Array of: object Signatures

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

Nested Schema : SubjectData

Type: array

Show Source

• Array of: object SubjectData

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

Nested Schema : Annotations

Type: object

Show Source

• Annotation: array Annotation

{
    "type":"object",
    "properties":{
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

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

Nested Schema : Annotation

Type: object

Show Source

• Comment: object Comment
• Flag: array Flag
• ID: string
• SeqNum: integer
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "Comment":{
            "$ref":"#/components/schemas/Comment"
        },
        "Flag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Flag"
            }
        },
        "SeqNum":{
            "type":"integer"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Comment

Type: object

Show Source

• SponsorOrSite: string
  Allowed Values: [ "SPONSOR", "SITE" ]
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "SponsorOrSite":{
            "type":"string",
            "enum":[
                "SPONSOR",
                "SITE"
            ]
        }
    }
}

Nested Schema : Flag

Type: array

Show Source

• Array of: object Flag

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

Nested Schema : Flag

Type: object

Show Source

• FlagType: object FlagType
• FlagValue: object FlagValue

{
    "type":"object",
    "properties":{
        "FlagValue":{
            "$ref":"#/components/schemas/FlagValue"
        },
        "FlagType":{
            "$ref":"#/components/schemas/FlagType"
        }
    }
}

Nested Schema : FlagType

Type: object

Show Source

• CodeListOID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : FlagValue

Type: object

Show Source

• CodeListOID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : AuditRecords

Type: object

Show Source

• AuditRecord: array AuditRecord

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecord"
            }
        }
    }
}

Nested Schema : AuditRecord

Type: array

Show Source

• Array of: object AuditRecord

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

Nested Schema : AuditRecord

Type: object

Show Source

• DateTimeStamp: object DateTimeStamp
• ID: string
• LocationRef: object LocationRef
• ReasonForChange: object ReasonForChange
• SourceID: object SourceID
• UserRef: object UserRef

{
    "type":"object",
    "properties":{
        "UserRef":{
            "$ref":"#/components/schemas/UserRef"
        },
        "LocationRef":{
            "$ref":"#/components/schemas/LocationRef"
        },
        "DateTimeStamp":{
            "$ref":"#/components/schemas/DateTimeStamp"
        },
        "ReasonForChange":{
            "$ref":"#/components/schemas/ReasonForChange"
        },
        "SourceID":{
            "$ref":"#/components/schemas/SourceID"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : DateTimeStamp

Type: object

Show Source

• FormattedValue: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "FormattedValue":{
            "type":"string"
        }
    }
}

Nested Schema : ReasonForChange

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : SourceID

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : UserRef

Type: object

Show Source

• UserOID: string

{
    "type":"object",
    "properties":{
        "UserOID":{
            "type":"string"
        }
    }
}

Nested Schema : Signatures

Type: object

Show Source

• Signature: array Signature

{
    "type":"object",
    "properties":{
        "Signature":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signature"
            }
        }
    }
}

Nested Schema : Signature

Type: array

Show Source

• Array of: object Signature

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

Nested Schema : Signature

Type: object

Show Source

• CryptoBindingManifest: object CryptoBindingManifest
• DateTimeStamp: object DateTimeStamp
• ID: string
• LocationRef: object LocationRef
• SignatureRef: object SignatureRef
• UserRef: object UserRef

{
    "type":"object",
    "properties":{
        "UserRef":{
            "$ref":"#/components/schemas/UserRef"
        },
        "LocationRef":{
            "$ref":"#/components/schemas/LocationRef"
        },
        "SignatureRef":{
            "$ref":"#/components/schemas/SignatureRef"
        },
        "DateTimeStamp":{
            "$ref":"#/components/schemas/DateTimeStamp"
        },
        "CryptoBindingManifest":{
            "$ref":"#/components/schemas/CryptoBindingManifest"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : CryptoBindingManifest

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : SignatureRef

Type: object

Show Source

• SignatureOID: string

{
    "type":"object",
    "properties":{
        "SignatureOID":{
            "type":"string"
        }
    }
}

Nested Schema : SubjectData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• Initials: string
• InvestigatorRef: object InvestigatorRef
• Signature: object Signature
• SiteRef: object SiteRef
• StudyEventData: array StudyEventData
• SubjectHistory: array SubjectHistory
• SubjectKey: string
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
• TransferData: array TransferData

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "InvestigatorRef":{
            "$ref":"#/components/schemas/InvestigatorRef"
        },
        "SiteRef":{
            "$ref":"#/components/schemas/SiteRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "StudyEventData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventData"
            }
        },
        "SubjectKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "Initials":{
            "type":"string"
        },
        "TransferData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferData"
            }
        },
        "SubjectHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/History"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

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

Nested Schema : InvestigatorRef

Type: object

Show Source

• UserOID: string

{
    "type":"object",
    "properties":{
        "UserOID":{
            "type":"string"
        }
    }
}

Nested Schema : SiteRef

Type: object

Show Source

• LocationOID: string
• Name: string

{
    "type":"object",
    "properties":{
        "LocationOID":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        }
    }
}

Nested Schema : StudyEventData

Type: array

Show Source

• Array of: object StudyEventData

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

Nested Schema : SubjectHistory

Type: array

Show Source

• Array of: object History

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

Nested Schema : TransferData

Type: array

Show Source

• Array of: object TransferData

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

Nested Schema : StudyEventData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• EventHistory: array EventHistory
• FormData: array FormData
• RepeatingFormSummary: object RepeatingFormSummary
• Signature: object Signature
• StudyEventOID: string
• StudyEventRepeatKey: string

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "FormData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormData"
            }
        },
        "StudyEventOID":{
            "type":"string"
        },
        "StudyEventRepeatKey":{
            "type":"string"
        },
        "RepeatingFormSummary":{
            "$ref":"#/components/schemas/RepeatingFormSummary"
        },
        "EventHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/History"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

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

Nested Schema : EventHistory

Type: array

Show Source

• Array of: object History

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

Nested Schema : FormData

Type: array

Show Source

• Array of: object FormData

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

Nested Schema : RepeatingFormSummary

Type: object

Show Source

• RepeatingFormData: array RepeatingFormData

{
    "type":"object",
    "properties":{
        "RepeatingFormData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepeatingFormData"
            }
        }
    }
}

Nested Schema : History

Type: object

Show Source

• action: string
• actionDate: string (date-time)
• details: array details

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string"
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "actionDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormData

Type: object

Show Source

• Annotation: array Annotation
• ArchiveLayoutRef: object ArchiveLayoutRef
• AuditRecord: object AuditRecord
• FormOID: string
• FormRepeatKey: string
• FormStatus: string
• ItemGroupData: array ItemGroupData
• NotDoneValue: string
• Signature: object Signature
• Signatures: object Signatures
• Status: string
• TitleAddendum: string
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "ArchiveLayoutRef":{
            "$ref":"#/components/schemas/ArchiveLayoutRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "ItemGroupData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupData"
            }
        },
        "FormOID":{
            "type":"string"
        },
        "FormRepeatKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "Status":{
            "type":"string"
        },
        "TitleAddendum":{
            "type":"string"
        },
        "FormStatus":{
            "type":"string"
        },
        "NotDoneValue":{
            "type":"string"
        },
        "Signatures":{
            "$ref":"#/components/schemas/Signatures"
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

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

Nested Schema : ArchiveLayoutRef

Type: object

Show Source

• ArchiveLayoutOID: string

{
    "type":"object",
    "properties":{
        "ArchiveLayoutOID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupData

Type: array

Show Source

• Array of: object ItemGroupData

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

Nested Schema : ItemGroupData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• ItemGroupOID: string
• ItemGroupRepeatKey: string
• Items: array Items
• Signature: object Signature
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "Items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemData"
            }
        },
        "ItemGroupOID":{
            "type":"string"
        },
        "ItemGroupRepeatKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

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

Nested Schema : Items

Type: array

Show Source

• Array of: object ItemData

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

Nested Schema : ItemData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• ItemOID: string
• MeasurementUnitRef: object MeasurementUnitRef
• NotDone: string
• ParentItemOID: string
• SelectedCodeListItemsType: string
• Signature: object Signature
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
• Value: string

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "MeasurementUnitRef":{
            "$ref":"#/components/schemas/MeasurementUnitRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "ItemOID":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ParentItemOID":{
            "type":"string"
        },
        "NotDone":{
            "type":"string"
        },
        "SelectedCodeListItemsType":{
            "type":"string"
        },
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

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

Nested Schema : MeasurementUnitRef

Type: object

Show Source

• MeasurementUnitOID: string

{
    "type":"object",
    "properties":{
        "MeasurementUnitOID":{
            "type":"string"
        }
    }
}

Nested Schema : RepeatingFormData

Type: array

Show Source

• Array of: object RepeatingFormData

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

Nested Schema : RepeatingFormData

Type: object

Show Source

• FormHeader: array FormHeader
• FormID: string
• FormOID: string
• Row: array Row
• SummaryNote: string

{
    "type":"object",
    "properties":{
        "FormOID":{
            "type":"string"
        },
        "FormID":{
            "type":"string"
        },
        "FormHeader":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormHeader"
            }
        },
        "Row":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Row"
            }
        },
        "SummaryNote":{
            "type":"string"
        }
    }
}

Nested Schema : FormHeader

Type: array

Show Source

• Array of: object FormHeader

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

Nested Schema : Row

Type: array

Show Source

• Array of: object Row

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

Nested Schema : FormHeader

Type: object

Show Source

• Itemset: boolean
• ItemsetHeader: string
• Name: string
• OID: string

{
    "type":"object",
    "properties":{
        "Itemset":{
            "type":"boolean"
        },
        "ItemsetHeader":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Row

Type: object

Show Source

• Associated: boolean
• AssociatedFormList: array AssociatedFormList
• Deleted: boolean
• FormIndex: number
• Item: array Item
• RowNo: string

{
    "type":"object",
    "properties":{
        "AssociatedFormList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedFormList"
            }
        },
        "RowNo":{
            "type":"string"
        },
        "FormIndex":{
            "type":"number"
        },
        "Associated":{
            "type":"boolean"
        },
        "Deleted":{
            "type":"boolean"
        },
        "Item":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Item"
            }
        }
    }
}

Nested Schema : AssociatedFormList

Type: array

Show Source

• Array of: object AssociatedFormList

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

Nested Schema : Item

Type: array

Show Source

• Array of: object Item

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

Nested Schema : AssociatedFormList

Type: object

Show Source

• AuditTrail: array AuditTrail
• Deleted: boolean
• FormIndex: number
• FormName: string
• FormOID: string
• InstanceNumber: integer
• VisitIndex: number
• VisitName: string
• VisitOID: string

{
    "type":"object",
    "properties":{
        "AuditTrail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditTrail"
            }
        },
        "FormOID":{
            "type":"string"
        },
        "FormIndex":{
            "type":"number"
        },
        "FormName":{
            "type":"string"
        },
        "VisitOID":{
            "type":"string"
        },
        "VisitIndex":{
            "type":"number"
        },
        "VisitName":{
            "type":"string"
        },
        "Deleted":{
            "type":"boolean"
        },
        "InstanceNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : AuditTrail

Type: array

Show Source

• Array of: object AuditTrail

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

Nested Schema : AuditTrail

Type: object

Show Source

• DateTimeStamp: string
• Deleted: boolean
• Note: string
• User: string

{
    "type":"object",
    "properties":{
        "DateTimeStamp":{
            "type":"string"
        },
        "User":{
            "type":"string"
        },
        "Deleted":{
            "type":"boolean"
        },
        "Note":{
            "type":"string"
        }
    }
}

Nested Schema : Item

Type: object

Show Source

• Itemset: boolean
• ItemsetRows: string
• OID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Itemset":{
            "type":"boolean"
        },
        "ItemsetRows":{
            "type":"string"
        },
        "Value":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : TransferData

Type: object

Show Source

• FromSiteName: string
• ToSiteName: string
• TransferDate: string

{
    "type":"object",
    "properties":{
        "FromSiteName":{
            "type":"string"
        },
        "ToSiteName":{
            "type":"string"
        },
        "TransferDate":{
            "type":"string"
        }
    }
}

Nested Schema : ReferenceData

Type: object

Show Source

• Annotations: array Annotations
• AuditRecords: array AuditRecords
• ItemGroupData: array ItemGroupData
• MetaDataVersionOID: string
• Signatures: array Signatures
• StudyOID: string

{
    "type":"object",
    "properties":{
        "ItemGroupData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupData"
            }
        },
        "AuditRecords":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecords"
            }
        },
        "Signatures":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signatures"
            }
        },
        "Annotations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotations"
            }
        },
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    }
}

Nested Schema : Annotations

Type: array

Show Source

• Array of: object Annotations

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

Nested Schema : AuditRecords

Type: array

Show Source

• Array of: object AuditRecords

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

Nested Schema : ItemGroupData

Type: array

Show Source

• Array of: object ItemGroupData

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

Nested Schema : Signatures

Type: array

Show Source

• Array of: object Signatures

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

Nested Schema : SignatureType

Type: object

Show Source

• ID: string
• KeyInfo: object KeyInfoType
• Object: array Object
• SignatureValue: object SignatureValueType
• SignedInfo: object SignedInfoType

{
    "type":"object",
    "properties":{
        "SignedInfo":{
            "$ref":"#/components/schemas/SignedInfoType"
        },
        "SignatureValue":{
            "$ref":"#/components/schemas/SignatureValueType"
        },
        "KeyInfo":{
            "$ref":"#/components/schemas/KeyInfoType"
        },
        "Object":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ObjectType"
            }
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : KeyInfoType

Type: object

Show Source

• Content: array Content
• ID: string

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Object

Type: array

Show Source

• Array of: object ObjectType

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

Nested Schema : SignatureValueType

Type: object

Show Source

• ID: string
• Value: array Value

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : SignedInfoType

Type: object

Show Source

• CanonicalizationMethod: object CanonicalizationMethodType
• ID: string
• Reference: array Reference
• SignatureMethod: object SignatureMethodType

{
    "type":"object",
    "properties":{
        "CanonicalizationMethod":{
            "$ref":"#/components/schemas/CanonicalizationMethodType"
        },
        "SignatureMethod":{
            "$ref":"#/components/schemas/SignatureMethodType"
        },
        "Reference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceType"
            }
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : ObjectType

Type: object

Show Source

• Content: array Content
• Encoding: string
• ID: string
• MimeType: string

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "MimeType":{
            "type":"string"
        },
        "Encoding":{
            "type":"string"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : Value

Type: array

Show Source

• Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : CanonicalizationMethodType

Type: object

Show Source

• Algorithm: string
• Content: array Content

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "Algorithm":{
            "type":"string"
        }
    }
}

Nested Schema : Reference

Type: array

Show Source

• Array of: object ReferenceType

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

Nested Schema : SignatureMethodType

Type: object

Show Source

• Algorithm: string
• Content: array Content

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "Algorithm":{
            "type":"string"
        }
    }
}

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : ReferenceType

Type: object

Show Source

• DigestMethod: object DigestMethodType
• DigestValue: array DigestValue
• ID: string
• Transforms: object TransformsType
• Type: string
• Uri: string

{
    "type":"object",
    "properties":{
        "Transforms":{
            "$ref":"#/components/schemas/TransformsType"
        },
        "DigestMethod":{
            "$ref":"#/components/schemas/DigestMethodType"
        },
        "DigestValue":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "Uri":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : DigestMethodType

Type: object

Show Source

• Algorithm: string
• Content: array Content

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "Algorithm":{
            "type":"string"
        }
    }
}

Nested Schema : DigestValue

Type: array

Show Source

• Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : TransformsType

Type: object

Show Source

• Transform: array Transform

{
    "type":"object",
    "properties":{
        "Transform":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransformType"
            }
        }
    }
}

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : Transform

Type: array

Show Source

• Array of: object TransformType

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

Nested Schema : TransformType

Type: object

Show Source

• Algorithm: string
• Content: array Content

{
    "type":"object",
    "properties":{
        "Content":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "Algorithm":{
            "type":"string"
        }
    }
}

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : Content

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : Study

Type: object

Show Source

• BasicDefinitions: object BasicDefinitions
• GlobalVariables: object GlobalVariables
• MetaDataVersion: array MetaDataVersion
• OID: string

{
    "type":"object",
    "properties":{
        "GlobalVariables":{
            "$ref":"#/components/schemas/GlobalVariables"
        },
        "BasicDefinitions":{
            "$ref":"#/components/schemas/BasicDefinitions"
        },
        "MetaDataVersion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetaDataVersion"
            }
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : BasicDefinitions

Type: object

Show Source

• MeasurementUnit: array MeasurementUnit

{
    "type":"object",
    "properties":{
        "MeasurementUnit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MeasurementUnit"
            }
        }
    }
}

Nested Schema : GlobalVariables

Type: object

Show Source

• ProtocolName: object ProtocolName
• StudyDescription: object StudyDescription
• StudyName: object StudyName

{
    "type":"object",
    "properties":{
        "StudyName":{
            "$ref":"#/components/schemas/StudyName"
        },
        "StudyDescription":{
            "$ref":"#/components/schemas/StudyDescription"
        },
        "ProtocolName":{
            "$ref":"#/components/schemas/ProtocolName"
        }
    }
}

Nested Schema : MetaDataVersion

Type: array

Show Source

• Array of: object MetaDataVersion

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

Nested Schema : MeasurementUnit

Type: array

Show Source

• Array of: object MeasurementUnit

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

Nested Schema : MeasurementUnit

Type: object

Show Source

• Alias: array Alias
• Name: string
• OID: string
• Symbol: object Symbol

{
    "type":"object",
    "properties":{
        "Symbol":{
            "$ref":"#/components/schemas/Symbol"
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : Symbol

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : Alias

Type: object

Show Source

• Context: string
• Name: string

{
    "type":"object",
    "properties":{
        "Context":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : TranslatedText

Type: object

Show Source

• lang: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "lang":{
            "type":"string"
        }
    }
}

Nested Schema : ProtocolName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : StudyDescription

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : StudyName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : MetaDataVersion

Type: object

Show Source

• CodeList: array CodeList
• ConditionDef: array ConditionDef
• Description: string
• FormDef: array FormDef
• ImputationMethod: array ImputationMethod
• Include: object Include
• ItemDef: array ItemDef
• ItemGroupDef: array ItemGroupDef
• MethodDef: array MethodDef
• Name: string
• OID: string
• Presentation: array Presentation
• Protocol: object Protocol
• StudyEventDef: array StudyEventDef

{
    "type":"object",
    "properties":{
        "Include":{
            "$ref":"#/components/schemas/Include"
        },
        "Protocol":{
            "$ref":"#/components/schemas/Protocol"
        },
        "StudyEventDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventDef"
            }
        },
        "FormDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormDef"
            }
        },
        "ItemGroupDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupDef"
            }
        },
        "ItemDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemDef"
            }
        },
        "CodeList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeList"
            }
        },
        "ImputationMethod":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImputationMethod"
            }
        },
        "Presentation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Presentation"
            }
        },
        "ConditionDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConditionDef"
            }
        },
        "MethodDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MethodDef"
            }
        },
        "Name":{
            "type":"string"
        },
        "Description":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : CodeList

Type: array

Show Source

• Array of: object CodeList

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

Nested Schema : ConditionDef

Type: array

Show Source

• Array of: object ConditionDef

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

Nested Schema : FormDef

Type: array

Show Source

• Array of: object FormDef

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

Nested Schema : ImputationMethod

Type: array

Show Source

• Array of: object ImputationMethod

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

Nested Schema : Include

Type: object

Show Source

• MetaDataVersionOID: string
• StudyOID: string

{
    "type":"object",
    "properties":{
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemDef

Type: array

Show Source

• Array of: object ItemDef

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

Nested Schema : ItemGroupDef

Type: array

Show Source

• Array of: object ItemGroupDef

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

Nested Schema : MethodDef

Type: array

Show Source

• Array of: object MethodDef

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

Nested Schema : Presentation

Type: array

Show Source

• Array of: object Presentation

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

Nested Schema : Protocol

Type: object

Show Source

• Alias: array Alias
• Description: object Description
• StudyEventRef: array StudyEventRef

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "StudyEventRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventRef"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        }
    }
}

Nested Schema : StudyEventDef

Type: array

Show Source

• Array of: object StudyEventDef

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

Nested Schema : CodeList

Type: object

Show Source

• Alias: array Alias
• DataType: string
  Allowed Values: [ "INTEGER", "FLOAT", "TEXT", "STRING" ]
• Description: object Description
• EnumeratedItem: array EnumeratedItem
• ExternalCodeList: object ExternalCodeList
• Items: array Items
• Name: string
• OID: string
• SasformatName: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "ExternalCodeList":{
            "$ref":"#/components/schemas/ExternalCodeList"
        },
        "EnumeratedItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnumeratedItem"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "DataType":{
            "type":"string",
            "enum":[
                "INTEGER",
                "FLOAT",
                "TEXT",
                "STRING"
            ]
        },
        "SasformatName":{
            "type":"string"
        },
        "Items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeListItem"
            }
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : Description

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : EnumeratedItem

Type: array

Show Source

• Array of: object EnumeratedItem

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

Nested Schema : ExternalCodeList

Type: object

Show Source

• Dictionary: string
• Href: string
• Ref: string
• Version: string

{
    "type":"object",
    "properties":{
        "Href":{
            "type":"string"
        },
        "Ref":{
            "type":"string"
        },
        "Dictionary":{
            "type":"string"
        },
        "Version":{
            "type":"string"
        }
    }
}

Nested Schema : Items

Type: array

Show Source

• Array of: object CodeListItem

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

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : EnumeratedItem

Type: object

Show Source

• Alias: array Alias
• CodedValue: string
• OrderNumber: integer
• Rank: number

{
    "type":"object",
    "properties":{
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "CodedValue":{
            "type":"string"
        },
        "Rank":{
            "type":"number"
        },
        "OrderNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : CodeListItem

Type: object

Show Source

• Alias: array Alias
• CodedValue: string
• Decode: object Decode
• OrderNumber: integer

{
    "type":"object",
    "properties":{
        "Decode":{
            "$ref":"#/components/schemas/Decode"
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "CodedValue":{
            "type":"string"
        },
        "OrderNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : Decode

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : ConditionDef

Type: object

Show Source

• Alias: array Alias
• Description: object Description
• FormalExpression: array FormalExpression
• Name: string
• OID: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "FormalExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : FormalExpression

Type: array

Show Source

• Array of: object FormalExpression

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

Nested Schema : FormalExpression

Type: object

Show Source

• Context: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "Context":{
            "type":"string"
        }
    }
}

Nested Schema : FormDef

Type: object

Show Source

• Alias: array Alias
• ArchiveLayout: array ArchiveLayout
• Description: object Description
• HasIPR: boolean
• ID: string
• ItemGroupRef: array ItemGroupRef
• Name: string
• Note: string
• OID: string
• Repeating: string
  Allowed Values: [ "Yes", "No" ]
• RevisionDate: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "ItemGroupRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupRef"
            }
        },
        "ArchiveLayout":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArchiveLayout"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Repeating":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "HasIPR":{
            "type":"boolean"
        },
        "Note":{
            "type":"string"
        },
        "RevisionDate":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : ArchiveLayout

Type: array

Show Source

• Array of: object ArchiveLayout

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

Nested Schema : ItemGroupRef

Type: array

Show Source

• Array of: object ItemGroupRef

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

Nested Schema : ArchiveLayout

Type: object

Show Source

• OID: string
• PdfFileName: string
• PresentationOID: string

{
    "type":"object",
    "properties":{
        "PdfFileName":{
            "type":"string"
        },
        "PresentationOID":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupRef

Type: object

Show Source

• CollectionExceptionConditionOID: string
• ItemGroupOID: string
• Mandatory: string
  Allowed Values: [ "Yes", "No" ]
• OrderNumber: integer

{
    "type":"object",
    "properties":{
        "OrderNumber":{
            "type":"integer"
        },
        "Mandatory":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "CollectionExceptionConditionOID":{
            "type":"string"
        },
        "ItemGroupOID":{
            "type":"string"
        }
    }
}

Nested Schema : ImputationMethod

Type: object

Show Source

• OID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemDef

Type: object

Show Source

• Alias: array Alias
• Calculated: string
• CaptionAlignment: string
  Allowed Values: [ "0", "1", "2", "3", "4", "5", "6" ]
• CaptionText: string
• CodeListRef: object CodeListRef
• Comment: string
• ControlLayout: string
  Allowed Values: [ "0", "1", "2", "3", "4", "5" ]
• ControlType: string
  Allowed Values: [ "pulldown", "text", "group", "radiogroup", "checkbox", "calendar", "element", "calculated", "instructionaltext" ]
• DataType: string
  Allowed Values: [ "integer", "float", "date", "datetime", "time", "text", "string", "double", "URI", "boolean", "hexBinary", "base64Binary", "hexFloat", "base64Float", "partialDate", "partialTime", "partialDatetime", "durationDatetime", "intervalDatetime", "incompleteDatetime", "incompleteDate", "incompleteTime" ]
• Description: object Description
• DisplayMask: string
• EndYear: string
• ExternalQuestion: object ExternalQuestion
• InitialRowCount: string
• IsDynamic: integer (int32)
• IsSmartItem: integer (int32)
• ItemRef: array ItemRef
• Length: integer
• MeasurementUnitRef: array MeasurementUnitRef
• Name: string
• OID: string
• Origin: string
• Question: object Question
• RangeCheck: array RangeCheck
• Role: array Role
• SasfieldName: string
• SdsvarName: string
• SelectionValue: string
• SignificantDigits: integer
• StartYear: string
• UnknownMask: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "Question":{
            "$ref":"#/components/schemas/Question"
        },
        "ExternalQuestion":{
            "$ref":"#/components/schemas/ExternalQuestion"
        },
        "MeasurementUnitRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MeasurementUnitRef"
            }
        },
        "RangeCheck":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RangeCheck"
            }
        },
        "CodeListRef":{
            "$ref":"#/components/schemas/CodeListRef"
        },
        "Role":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "DataType":{
            "type":"string",
            "enum":[
                "integer",
                "float",
                "date",
                "datetime",
                "time",
                "text",
                "string",
                "double",
                "URI",
                "boolean",
                "hexBinary",
                "base64Binary",
                "hexFloat",
                "base64Float",
                "partialDate",
                "partialTime",
                "partialDatetime",
                "durationDatetime",
                "intervalDatetime",
                "incompleteDatetime",
                "incompleteDate",
                "incompleteTime"
            ]
        },
        "Length":{
            "type":"integer"
        },
        "SignificantDigits":{
            "type":"integer"
        },
        "Origin":{
            "type":"string"
        },
        "Comment":{
            "type":"string"
        },
        "CaptionText":{
            "type":"string"
        },
        "ControlType":{
            "type":"string",
            "enum":[
                "pulldown",
                "text",
                "group",
                "radiogroup",
                "checkbox",
                "calendar",
                "element",
                "calculated",
                "instructionaltext"
            ]
        },
        "ControlLayout":{
            "type":"string",
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ]
        },
        "CaptionAlignment":{
            "type":"string",
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5",
                "6"
            ]
        },
        "InitialRowCount":{
            "type":"string"
        },
        "DisplayMask":{
            "type":"string"
        },
        "StartYear":{
            "type":"string"
        },
        "EndYear":{
            "type":"string"
        },
        "UnknownMask":{
            "type":"string"
        },
        "Calculated":{
            "type":"string"
        },
        "SelectionValue":{
            "type":"string"
        },
        "ItemRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemRef"
            }
        },
        "IsDynamic":{
            "type":"integer",
            "format":"int32"
        },
        "IsSmartItem":{
            "type":"integer",
            "format":"int32"
        },
        "SasfieldName":{
            "type":"string"
        },
        "SdsvarName":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : CodeListRef

Type: object

Show Source

• CodeListOID: string

{
    "type":"object",
    "properties":{
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : ExternalQuestion

Type: object

Show Source

• Code: string
• Dictionary: string
• Version: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Dictionary":{
            "type":"string"
        },
        "Version":{
            "type":"string"
        }
    }
}

Nested Schema : ItemRef

Type: array

Show Source

• Array of: object ITEMREF

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

Nested Schema : MeasurementUnitRef

Type: array

Show Source

• Array of: object MeasurementUnitRef

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

Nested Schema : Question

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : RangeCheck

Type: array

Show Source

• Array of: object RangeCheck

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

Nested Schema : Role

Type: array

Show Source

• Array of: object Role

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

Nested Schema : ITEMREF

Type: object

Show Source

• controlRef(required): object CONTROLREF
• guid: string
• refName: string
• revision: number (float)

{
    "required":[
        "controlRef"
    ],
    "type":"object",
    "properties":{
        "controlRef":{
            "$ref":"#/components/schemas/ControlRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"ITEMREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTROLREF

Type: object

Show Source

• controlRef: object CONTROLREF
• guid: string
• refName: string
• revision: number (float)

{
    "type":"object",
    "properties":{
        "controlRef":{
            "$ref":"#/components/schemas/ControlRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"CONTROLREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : RangeCheck

Type: object

Show Source

• CheckValue: array CheckValue
• Comparator: string
  Allowed Values: [ "LT", "LE", "GT", "GE", "EQ", "NE", "IN", "NOTIN" ]
• ErrorMessage: object ErrorMessage
• FormalExpression: array FormalExpression
• MeasurementUnitRef: object MeasurementUnitRef
• SoftHard: string
  Allowed Values: [ "SOFT", "HARD" ]

{
    "type":"object",
    "properties":{
        "CheckValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CheckValue"
            }
        },
        "FormalExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "MeasurementUnitRef":{
            "$ref":"#/components/schemas/MeasurementUnitRef"
        },
        "ErrorMessage":{
            "$ref":"#/components/schemas/ErrorMessage"
        },
        "Comparator":{
            "type":"string",
            "enum":[
                "LT",
                "LE",
                "GT",
                "GE",
                "EQ",
                "NE",
                "IN",
                "NOTIN"
            ]
        },
        "SoftHard":{
            "type":"string",
            "enum":[
                "SOFT",
                "HARD"
            ]
        }
    }
}

Nested Schema : CheckValue

Type: array

Show Source

• Array of: object CheckValue

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

Nested Schema : ErrorMessage

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : FormalExpression

Type: array

Show Source

• Array of: object FormalExpression

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

Nested Schema : CheckValue

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : Role

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupDef

Type: object

Show Source

• Alias: array Alias
• Comment: string
• Description: object Description
• Domain: string
• IsReferenceData: string
  Allowed Values: [ "Yes", "No" ]
• ItemRef: array ItemRef
• Name: string
• OID: string
• Origin: string
• Purpose: string
• Repeating: string
  Allowed Values: [ "Yes", "No" ]
• Role: string
• SasdatasetName: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "ItemRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemRef"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Repeating":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "IsReferenceData":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "Domain":{
            "type":"string"
        },
        "Origin":{
            "type":"string"
        },
        "Role":{
            "type":"string"
        },
        "Purpose":{
            "type":"string"
        },
        "Comment":{
            "type":"string"
        },
        "SasdatasetName":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : ItemRef

Type: array

Show Source

• Array of: object ITEMREF

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

Nested Schema : MethodDef

Type: object

Show Source

• Alias: array Alias
• Description: object Description
• FormalExpression: array FormalExpression
• Name: string
• OID: string
• Type: string
  Allowed Values: [ "COMPUTATION", "IMPUTATION", "TRANSPOSE", "OTHER" ]

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "FormalExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Type":{
            "type":"string",
            "enum":[
                "COMPUTATION",
                "IMPUTATION",
                "TRANSPOSE",
                "OTHER"
            ]
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : FormalExpression

Type: array

Show Source

• Array of: object FormalExpression

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

Nested Schema : Presentation

Type: object

Show Source

• Lang: string
• OID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "Lang":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : StudyEventRef

Type: array

Show Source

• Array of: object StudyEventRef

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

Nested Schema : StudyEventRef

Type: object

Show Source

• CollectionExceptionConditionOID: string
• Mandatory: string
  Allowed Values: [ "Yes", "No" ]
• OrderNumber: integer
• StudyEventOID: string

{
    "type":"object",
    "properties":{
        "OrderNumber":{
            "type":"integer"
        },
        "Mandatory":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "CollectionExceptionConditionOID":{
            "type":"string"
        },
        "StudyEventOID":{
            "type":"string"
        }
    }
}

Nested Schema : StudyEventDef

Type: object

Show Source

• Alias: array Alias
• Category: string
• Description: object Description
• FormRef: array FormRef
• Name: string
• OID: string
• Repeating: string
  Allowed Values: [ "Yes", "No" ]
• Type: string
  Allowed Values: [ "Scheduled", "Unscheduled", "Common" ]

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "FormRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormRef"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Repeating":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "Type":{
            "type":"string",
            "enum":[
                "Scheduled",
                "Unscheduled",
                "Common"
            ]
        },
        "Category":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : FormRef

Type: array

Show Source

• Array of: object FORMREF

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

Nested Schema : FORMREF

Type: object

Show Source

• guid: string
• name: string
• order: integer (int64)
• refName: string
• revision: number (float)
• sectionRef(required): object SECTIONREF

{
    "required":[
        "sectionRef"
    ],
    "type":"object",
    "properties":{
        "sectionRef":{
            "$ref":"#/components/schemas/SectionRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "order":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"ORDER",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"FORMREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SECTIONREF

Type: object

Show Source

• guid: string
• itemRef: object ITEMREF
• itemSetRef: object ITEMSETREF
• refName: string
• revision: number (float)

{
    "type":"object",
    "properties":{
        "itemRef":{
            "$ref":"#/components/schemas/ItemRef"
        },
        "itemSetRef":{
            "$ref":"#/components/schemas/ItemSetRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SECTIONREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : ITEMSETREF

Type: object

Show Source

• guid: string
• itemRef(required): object ITEMREF
• order: integer (int64)
• refName: string
• revision: number (float)

{
    "required":[
        "itemRef"
    ],
    "type":"object",
    "properties":{
        "itemRef":{
            "$ref":"#/components/schemas/ItemRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        },
        "order":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"ORDER",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"ITEMSETREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

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

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

Nested Schema : details

Type: object

Back to Top