REST API for Clinical One Platform

ODM extract for meta data

get

/ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/metadata

This API is used to extract meta data in CDISC ODM-XML format. Right: ODMMetaDataGet.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training. This will retrieve all study versions currently in that mode container, plus the study versions that were archived from that mode container.
studyId(required): string

ID of the study

Query Parameters

fromTimestamp: string

Extract study versions that were created after this timestamp only in the ODM Extract. It accepts yyy-MM-dd'T'HH:mm:ss.SSS'Z' date format.
includeCOExtensions: string

If the value is true, the data extract will include both the CDISC standard elements and Clinical One extension elements in the extract. If the value is false, the extracted data will only consist of the CDISC standard elements. It accepts true or false, or y or n. The default value is true.
limit: integer(int32)

The number of study versions, beginning with the offset, that you want to retrieve. Offset must be provided to use this parameter. For example, if you want to retrieve study versions in multiple batches of 10, you can start with an offset of 0 and limit of 10, then repeat calls to this endpoint and increase the offset value by 10 each time.
offset: integer(int32)

An order number that specifies which study version you want to start retrieving meta data from. If provided, you also need to specify a value for the limit parameter.
studyVersion: string

The version of the study to extract data from in the ODM Extract.
studyVersionSummary: string

If the value is true, only summary data is displayed for the study version in the ODM extract. If the value is false, both summary data and complete design data is displayed for the study version in the ODM Extract. It accepts true or false, or y or n. The default value is false.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Successful operation

Root Schema : ODM

Type: object

Show Source

archival: string

Allowed Values: [ "YES" ]
asOfDateTime: string (date-time)
count: integer (int32)
creationDateTime: string (date-time)
description: string
excludeHiddenData: string
fileOID: string
fileType: string

Allowed Values: [ "SNAPSHOT", "TRANSACTIONAL" ]
fromDate: string (date-time)
granularity: string

Allowed Values: [ "ALL", "METADATA", "ADMIN_DATA", "REFERENCE_DATA", "ALL_CLINICAL_DATA", "SINGLE_SITE", "SINGLE_SUBJECT" ]
hasMore: boolean
id: string
includeCOExtensions: string
includeLocations: string
includeUsers: string
limit: integer (int32)
odmVersion: string
offset: integer (int32)
originator: string
priorFileOID: string
sourceSystem: string
sourceSystemVersion: string
study: array Study
studyMode: string
studyVersion: string
studyVersionSummary: boolean
toDate: string (date-time)
totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "study":{
            "type":"array",
            "xml":{
                "name":"Study"
            },
            "items":{
                "$ref":"#/components/schemas/Study"
            }
        },
        "studyMode":{
            "type":"string",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "includeCOExtensions":{
            "type":"string",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "excludeHiddenData":{
            "type":"string",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "fromDate":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"fromTimestamp",
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "toDate":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"toTimestamp",
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "studyVersion":{
            "type":"string",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "studyVersionSummary":{
            "type":"boolean",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "includeUsers":{
            "type":"string",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "includeLocations":{
            "type":"string",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "hasMore":{
            "type":"boolean",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "namespace":"https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1",
                "attribute":true
            }
        },
        "description":{
            "type":"string",
            "xml":{
                "name":"Description",
                "attribute":true
            }
        },
        "fileType":{
            "type":"string",
            "xml":{
                "name":"FileType",
                "attribute":true
            },
            "enum":[
                "SNAPSHOT",
                "TRANSACTIONAL"
            ]
        },
        "granularity":{
            "type":"string",
            "xml":{
                "name":"Granularity",
                "attribute":true
            },
            "enum":[
                "ALL",
                "METADATA",
                "ADMIN_DATA",
                "REFERENCE_DATA",
                "ALL_CLINICAL_DATA",
                "SINGLE_SITE",
                "SINGLE_SUBJECT"
            ]
        },
        "archival":{
            "type":"string",
            "xml":{
                "name":"Archival",
                "attribute":true
            },
            "enum":[
                "YES"
            ]
        },
        "fileOID":{
            "type":"string",
            "xml":{
                "name":"FileOID",
                "attribute":true
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"CreationDateTime",
                "attribute":true
            }
        },
        "priorFileOID":{
            "type":"string",
            "xml":{
                "name":"PriorFileOID",
                "attribute":true
            }
        },
        "asOfDateTime":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"AsOfDateTime",
                "attribute":true
            }
        },
        "odmVersion":{
            "type":"string",
            "xml":{
                "name":"ODMVersion",
                "attribute":true
            }
        },
        "originator":{
            "type":"string",
            "xml":{
                "name":"Originator",
                "attribute":true
            }
        },
        "sourceSystem":{
            "type":"string",
            "xml":{
                "name":"SourceSystem",
                "attribute":true
            }
        },
        "sourceSystemVersion":{
            "type":"string",
            "xml":{
                "name":"SourceSystemVersion",
                "attribute":true
            }
        },
        "id":{
            "type":"string",
            "xml":{
                "name":"ID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"ODM"
    }
}

Nested Schema : Study

Type: array

Show Source

Array of: object Study

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

Nested Schema : Study

Type: object

Show Source

basicDefinitions: object BasicDefinitions
globalVariables(required): object GlobalVariables
metaDataVersion: array metaDataVersion
oid: string

{
    "required":[
        "globalVariables"
    ],
    "type":"object",
    "properties":{
        "globalVariables":{
            "$ref":"#/components/schemas/GlobalVariables"
        },
        "basicDefinitions":{
            "$ref":"#/components/schemas/BasicDefinitions"
        },
        "metaDataVersion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetaDataVersion"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        }
    }
}

Nested Schema : BasicDefinitions

Type: object

Show Source

measurementUnit: array MeasurementUnit

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

Nested Schema : GlobalVariables

Type: object

Show Source

protocolName(required): object ProtocolName
studyDescription(required): object StudyDescription
studyName(required): object StudyName

{
    "required":[
        "protocolName",
        "studyDescription",
        "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",
    "xml":{
        "name":"MeasurementUnit"
    },
    "items":{
        "$ref":"#/components/schemas/MeasurementUnit"
    }
}

Nested Schema : MeasurementUnit

Type: object

Show Source

alias: array Alias
name: string
oid: string
symbol(required): object Symbol

{
    "required":[
        "symbol"
    ],
    "type":"object",
    "properties":{
        "symbol":{
            "$ref":"#/components/schemas/Symbol"
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : Symbol

Type: object

Show Source

translatedText(required): array TranslatedText

{
    "required":[
        "translatedText"
    ],
    "type":"object",
    "properties":{
        "translatedText":{
            "type":"array",
            "xml":{
                "name":"TranslatedText"
            },
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : Alias

Type: object

Show Source

context: string
name: string

{
    "type":"object",
    "properties":{
        "context":{
            "type":"string",
            "xml":{
                "name":"Context",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

Array of: object TranslatedText

{
    "type":"array",
    "xml":{
        "name":"TranslatedText"
    },
    "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",
            "xml":{
                "namespace":"http://www.w3.org/XML/1998/namespace",
                "attribute":true
            }
        }
    }
}

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",
            "xml":{
                "name":"CodeList"
            },
            "items":{
                "$ref":"#/components/schemas/CodeList"
            }
        },
        "imputationMethod":{
            "type":"array",
            "xml":{
                "name":"ImputationMethod"
            },
            "items":{
                "$ref":"#/components/schemas/ImputationMethod"
            }
        },
        "presentation":{
            "type":"array",
            "xml":{
                "name":"Presentation"
            },
            "items":{
                "$ref":"#/components/schemas/Presentation"
            }
        },
        "conditionDef":{
            "type":"array",
            "xml":{
                "name":"ConditionDef"
            },
            "items":{
                "$ref":"#/components/schemas/ConditionDef"
            }
        },
        "methodDef":{
            "type":"array",
            "xml":{
                "name":"MethodDef"
            },
            "items":{
                "$ref":"#/components/schemas/MethodDef"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "description":{
            "type":"string",
            "xml":{
                "name":"Description",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"MetaDataVersion",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : CodeList

Type: array

Show Source

Array of: object CodeList

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

Nested Schema : ConditionDef

Type: array

Show Source

Array of: object ConditionDef

{
    "type":"array",
    "xml":{
        "name":"ConditionDef"
    },
    "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",
    "xml":{
        "name":"ImputationMethod"
    },
    "items":{
        "$ref":"#/components/schemas/ImputationMethod"
    }
}

Nested Schema : Include

Type: object

Show Source

metaDataVersionOID: string
studyOID: string

{
    "type":"object",
    "properties":{
        "studyOID":{
            "type":"string",
            "xml":{
                "name":"StudyOID",
                "attribute":true
            }
        },
        "metaDataVersionOID":{
            "type":"string",
            "xml":{
                "name":"MetaDataVersionOID",
                "attribute":true
            }
        }
    }
}

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",
    "xml":{
        "name":"MethodDef"
    },
    "items":{
        "$ref":"#/components/schemas/MethodDef"
    }
}

Nested Schema : Presentation

Type: array

Show Source

Array of: object Presentation

{
    "type":"array",
    "xml":{
        "name":"Presentation"
    },
    "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",
            "xml":{
                "name":"StudyEventRef"
            },
            "items":{
                "$ref":"#/components/schemas/StudyEventRef"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "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
codeListItem: array codeListItem
dataType: string

Allowed Values: [ "INTEGER", "FLOAT", "TEXT", "STRING" ]
description: object Description
enumeratedItem: array EnumeratedItem
externalCodeList: object ExternalCodeList
name: string
oid: string
sasformatName: string

{
    "type":"object",
    "properties":{
        "description":{
            "$ref":"#/components/schemas/Description"
        },
        "codeListItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeListItem"
            }
        },
        "externalCodeList":{
            "$ref":"#/components/schemas/ExternalCodeList"
        },
        "enumeratedItem":{
            "type":"array",
            "xml":{
                "name":"EnumeratedItem"
            },
            "items":{
                "$ref":"#/components/schemas/EnumeratedItem"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "dataType":{
            "type":"string",
            "xml":{
                "name":"DataType",
                "attribute":true
            },
            "enum":[
                "INTEGER",
                "FLOAT",
                "TEXT",
                "STRING"
            ]
        },
        "sasformatName":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : codeListItem

Type: array

Show Source

Array of: object CodeListItem

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

Nested Schema : Description

Type: object

Show Source

translatedText(required): array TranslatedText

{
    "required":[
        "translatedText"
    ],
    "type":"object",
    "properties":{
        "translatedText":{
            "type":"array",
            "xml":{
                "name":"TranslatedText"
            },
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : EnumeratedItem

Type: array

Show Source

Array of: object EnumeratedItem

{
    "type":"array",
    "xml":{
        "name":"EnumeratedItem"
    },
    "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",
            "xml":{
                "attribute":true
            }
        },
        "ref":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "dictionary":{
            "type":"string",
            "xml":{
                "name":"Dictionary",
                "attribute":true
            }
        },
        "version":{
            "type":"string",
            "xml":{
                "name":"Version",
                "attribute":true
            }
        }
    }
}

Nested Schema : CodeListItem

Type: object

Show Source

alias: array Alias
codedValue: string
decode(required): object Decode
orderNumber: integer
rank: number

{
    "required":[
        "decode"
    ],
    "type":"object",
    "properties":{
        "decode":{
            "$ref":"#/components/schemas/Decode"
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "codedValue":{
            "type":"string",
            "xml":{
                "name":"CodedValue",
                "attribute":true
            }
        },
        "rank":{
            "type":"number",
            "xml":{
                "name":"Rank",
                "attribute":true
            }
        },
        "orderNumber":{
            "type":"integer",
            "xml":{
                "name":"OrderNumber",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"CodeListItem",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : Decode

Type: object

Show Source

translatedText(required): array TranslatedText

{
    "required":[
        "translatedText"
    ],
    "type":"object",
    "properties":{
        "translatedText":{
            "type":"array",
            "xml":{
                "name":"TranslatedText"
            },
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

Array of: object TranslatedText

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

Nested Schema : TranslatedText

Type: array

Show Source

Array of: object TranslatedText

{
    "type":"array",
    "xml":{
        "name":"TranslatedText"
    },
    "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",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "codedValue":{
            "type":"string",
            "xml":{
                "name":"CodedValue",
                "attribute":true
            }
        },
        "rank":{
            "type":"number",
            "xml":{
                "name":"Rank",
                "attribute":true
            }
        },
        "orderNumber":{
            "type":"integer",
            "xml":{
                "name":"OrderNumber",
                "attribute":true
            }
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : ConditionDef

Type: object

Show Source

alias: array Alias
description(required): object Description
formalExpression: array FormalExpression
name: string
oid: string

{
    "required":[
        "description"
    ],
    "type":"object",
    "properties":{
        "description":{
            "$ref":"#/components/schemas/Description"
        },
        "formalExpression":{
            "type":"array",
            "xml":{
                "name":"FormalExpression"
            },
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : FormalExpression

Type: array

Show Source

Array of: object FormalExpression

{
    "type":"array",
    "xml":{
        "name":"FormalExpression"
    },
    "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",
            "xml":{
                "name":"Context",
                "attribute":true
            }
        }
    }
}

Nested Schema : FormDef

Type: object

Show Source

alias: array Alias
archiveLayout: array ArchiveLayout
description: object Description
itemGroupRef: array ItemGroupRef
name: string
oid: string
repeating: string

Allowed Values: [ "YES", "NO" ]

{
    "type":"object",
    "properties":{
        "description":{
            "$ref":"#/components/schemas/Description"
        },
        "itemGroupRef":{
            "type":"array",
            "xml":{
                "name":"ItemGroupRef"
            },
            "items":{
                "$ref":"#/components/schemas/ItemGroupRef"
            }
        },
        "archiveLayout":{
            "type":"array",
            "xml":{
                "name":"ArchiveLayout"
            },
            "items":{
                "$ref":"#/components/schemas/ArchiveLayout"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "repeating":{
            "type":"string",
            "xml":{
                "name":"Repeating",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        }
    },
    "xml":{
        "name":"FormDef",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : ArchiveLayout

Type: array

Show Source

Array of: object ArchiveLayout

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

Nested Schema : ItemGroupRef

Type: array

Show Source

Array of: object ItemGroupRef

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

Nested Schema : ArchiveLayout

Type: object

Show Source

oid: string
pdfFileName: string
presentationOID: string

{
    "type":"object",
    "properties":{
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "pdfFileName":{
            "type":"string",
            "xml":{
                "name":"PdfFileName",
                "attribute":true
            }
        },
        "presentationOID":{
            "type":"string",
            "xml":{
                "name":"PresentationOID",
                "attribute":true
            }
        }
    }
}

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",
            "xml":{
                "name":"OrderNumber",
                "attribute":true
            }
        },
        "mandatory":{
            "type":"string",
            "xml":{
                "name":"Mandatory",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "xml":{
                "name":"CollectionExceptionConditionOID",
                "attribute":true
            }
        },
        "itemGroupOID":{
            "type":"string",
            "xml":{
                "name":"ItemGroupOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : ImputationMethod

Type: object

Show Source

oid: string
value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        }
    }
}

Nested Schema : ItemDef

Type: object

Show Source

alias: array Alias
codeListRef: object CodeListRef
comment: string
dataType: string

Allowed Values: [ "INTEGER", "FLOAT", "DATE", "DATETIME", "TIME", "TEXT", "STRING", "DOUBLE", "URI", "BOOLEAN", "HEX_BINARY", "BASE_64_BINARY", "HEX_FLOAT", "BASE_64_FLOAT", "PARTIAL_DATE", "PARTIAL_TIME", "PARTIAL_DATETIME", "DURATION_DATETIME", "INTERVAL_DATETIME", "INCOMPLETE_DATETIME", "INCOMPLETE_DATE", "INCOMPLETE_TIME" ]
description: object Description
externalQuestion: object ExternalQuestion
length: integer
measurementUnitRef: array MeasurementUnitRef
name: string
oid: string
origin: string
question: object Question
rangeCheck: array RangeCheck
role: array Role
sasfieldName: string
sdsvarName: string
significantDigits: integer

{
    "type":"object",
    "properties":{
        "description":{
            "$ref":"#/components/schemas/Description"
        },
        "question":{
            "$ref":"#/components/schemas/Question"
        },
        "externalQuestion":{
            "$ref":"#/components/schemas/ExternalQuestion"
        },
        "measurementUnitRef":{
            "type":"array",
            "xml":{
                "name":"MeasurementUnitRef"
            },
            "items":{
                "$ref":"#/components/schemas/MeasurementUnitRef"
            }
        },
        "rangeCheck":{
            "type":"array",
            "xml":{
                "name":"RangeCheck"
            },
            "items":{
                "$ref":"#/components/schemas/RangeCheck"
            }
        },
        "codeListRef":{
            "$ref":"#/components/schemas/CodeListRef"
        },
        "role":{
            "type":"array",
            "xml":{
                "name":"Role"
            },
            "items":{
                "$ref":"#/components/schemas/Role"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "dataType":{
            "type":"string",
            "xml":{
                "name":"DataType",
                "attribute":true
            },
            "enum":[
                "INTEGER",
                "FLOAT",
                "DATE",
                "DATETIME",
                "TIME",
                "TEXT",
                "STRING",
                "DOUBLE",
                "URI",
                "BOOLEAN",
                "HEX_BINARY",
                "BASE_64_BINARY",
                "HEX_FLOAT",
                "BASE_64_FLOAT",
                "PARTIAL_DATE",
                "PARTIAL_TIME",
                "PARTIAL_DATETIME",
                "DURATION_DATETIME",
                "INTERVAL_DATETIME",
                "INCOMPLETE_DATETIME",
                "INCOMPLETE_DATE",
                "INCOMPLETE_TIME"
            ]
        },
        "length":{
            "type":"integer",
            "xml":{
                "name":"Length",
                "attribute":true
            }
        },
        "significantDigits":{
            "type":"integer",
            "xml":{
                "name":"SignificantDigits",
                "attribute":true
            }
        },
        "origin":{
            "type":"string",
            "xml":{
                "name":"Origin",
                "attribute":true
            }
        },
        "comment":{
            "type":"string",
            "xml":{
                "name":"Comment",
                "attribute":true
            }
        },
        "sasfieldName":{
            "type":"string"
        },
        "sdsvarName":{
            "type":"string"
        }
    },
    "xml":{
        "name":"ItemDef",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : CodeListRef

Type: object

Show Source

codeListOID: string

{
    "type":"object",
    "properties":{
        "codeListOID":{
            "type":"string",
            "xml":{
                "name":"CodeListOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : ExternalQuestion

Type: object

Show Source

code: string
dictionary: string
version: string

{
    "type":"object",
    "properties":{
        "dictionary":{
            "type":"string",
            "xml":{
                "name":"Dictionary",
                "attribute":true
            }
        },
        "version":{
            "type":"string",
            "xml":{
                "name":"Version",
                "attribute":true
            }
        },
        "code":{
            "type":"string",
            "xml":{
                "name":"Code",
                "attribute":true
            }
        }
    }
}

Nested Schema : MeasurementUnitRef

Type: array

Show Source

Array of: object MeasurementUnitRef

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

Nested Schema : Question

Type: object

Show Source

translatedText(required): array TranslatedText

{
    "required":[
        "translatedText"
    ],
    "type":"object",
    "properties":{
        "translatedText":{
            "type":"array",
            "xml":{
                "name":"TranslatedText"
            },
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : RangeCheck

Type: array

Show Source

Array of: object RangeCheck

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

Nested Schema : Role

Type: array

Show Source

Array of: object Role

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

Nested Schema : MeasurementUnitRef

Type: object

Show Source

measurementUnitOID: string

{
    "type":"object",
    "properties":{
        "measurementUnitOID":{
            "type":"string",
            "xml":{
                "name":"MeasurementUnitOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

Array of: object TranslatedText

{
    "type":"array",
    "xml":{
        "name":"TranslatedText"
    },
    "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",
            "xml":{
                "name":"CheckValue"
            },
            "items":{
                "$ref":"#/components/schemas/CheckValue"
            }
        },
        "formalExpression":{
            "type":"array",
            "xml":{
                "name":"FormalExpression"
            },
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "measurementUnitRef":{
            "$ref":"#/components/schemas/MeasurementUnitRef"
        },
        "errorMessage":{
            "$ref":"#/components/schemas/ErrorMessage"
        },
        "comparator":{
            "type":"string",
            "xml":{
                "name":"Comparator",
                "attribute":true
            },
            "enum":[
                "LT",
                "LE",
                "GT",
                "GE",
                "EQ",
                "NE",
                "IN",
                "NOTIN"
            ]
        },
        "softHard":{
            "type":"string",
            "xml":{
                "name":"SoftHard",
                "attribute":true
            },
            "enum":[
                "SOFT",
                "HARD"
            ]
        }
    }
}

Nested Schema : CheckValue

Type: array

Show Source

Array of: object CheckValue

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

Nested Schema : ErrorMessage

Type: object

Show Source

translatedText(required): array TranslatedText

{
    "required":[
        "translatedText"
    ],
    "type":"object",
    "properties":{
        "translatedText":{
            "type":"array",
            "xml":{
                "name":"TranslatedText"
            },
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : FormalExpression

Type: array

Show Source

Array of: object FormalExpression

{
    "type":"array",
    "xml":{
        "name":"FormalExpression"
    },
    "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",
    "xml":{
        "name":"TranslatedText"
    },
    "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",
            "xml":{
                "name":"ItemRef"
            },
            "items":{
                "$ref":"#/components/schemas/ItemRef"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "repeating":{
            "type":"string",
            "xml":{
                "name":"Repeating",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "isReferenceData":{
            "type":"string",
            "xml":{
                "name":"IsReferenceData",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "domain":{
            "type":"string",
            "xml":{
                "name":"Domain",
                "attribute":true
            }
        },
        "origin":{
            "type":"string",
            "xml":{
                "name":"Origin",
                "attribute":true
            }
        },
        "role":{
            "type":"string",
            "xml":{
                "name":"Role",
                "attribute":true
            }
        },
        "purpose":{
            "type":"string",
            "xml":{
                "name":"Purpose",
                "attribute":true
            }
        },
        "comment":{
            "type":"string",
            "xml":{
                "name":"Comment",
                "attribute":true
            }
        },
        "sasdatasetName":{
            "type":"string"
        }
    },
    "xml":{
        "name":"ItemGroupDef",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : ItemRef

Type: array

Show Source

Array of: object ItemRef

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

Nested Schema : ItemRef

Type: object

Show Source

collectionExceptionConditionOID: string
imputationMethodOID: string
itemOID: string
keySequence: integer
mandatory: string

Allowed Values: [ "YES", "NO" ]
methodOID: string
orderNumber: integer
role: string
roleCodeListOID: string

{
    "type":"object",
    "properties":{
        "orderNumber":{
            "type":"integer",
            "xml":{
                "name":"OrderNumber",
                "attribute":true
            }
        },
        "mandatory":{
            "type":"string",
            "xml":{
                "name":"Mandatory",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "xml":{
                "name":"CollectionExceptionConditionOID",
                "attribute":true
            }
        },
        "itemOID":{
            "type":"string",
            "xml":{
                "name":"ItemOID",
                "attribute":true
            }
        },
        "keySequence":{
            "type":"integer",
            "xml":{
                "name":"KeySequence",
                "attribute":true
            }
        },
        "methodOID":{
            "type":"string",
            "xml":{
                "name":"MethodOID",
                "attribute":true
            }
        },
        "imputationMethodOID":{
            "type":"string",
            "xml":{
                "name":"ImputationMethodOID",
                "attribute":true
            }
        },
        "role":{
            "type":"string",
            "xml":{
                "name":"Role",
                "attribute":true
            }
        },
        "roleCodeListOID":{
            "type":"string",
            "xml":{
                "name":"RoleCodeListOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : MethodDef

Type: object

Show Source

alias: array Alias
description(required): object Description
formalExpression: array FormalExpression
name: string
oid: string
type: string

Allowed Values: [ "COMPUTATION", "IMPUTATION", "TRANSPOSE", "OTHER" ]

{
    "required":[
        "description"
    ],
    "type":"object",
    "properties":{
        "description":{
            "$ref":"#/components/schemas/Description"
        },
        "formalExpression":{
            "type":"array",
            "xml":{
                "name":"FormalExpression"
            },
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"Type",
                "attribute":true
            },
            "enum":[
                "COMPUTATION",
                "IMPUTATION",
                "TRANSPOSE",
                "OTHER"
            ]
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : FormalExpression

Type: array

Show Source

Array of: object FormalExpression

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

Nested Schema : Presentation

Type: object

Show Source

lang: string
oid: string
value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "lang":{
            "type":"string",
            "xml":{
                "namespace":"http://www.w3.org/XML/1998/namespace",
                "attribute":true
            }
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : StudyEventRef

Type: array

Show Source

Array of: object StudyEventRef

{
    "type":"array",
    "xml":{
        "name":"StudyEventRef"
    },
    "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":{
        "studyEventOID":{
            "type":"string",
            "xml":{
                "name":"StudyEventOID",
                "attribute":true
            }
        },
        "orderNumber":{
            "type":"integer",
            "xml":{
                "name":"OrderNumber",
                "attribute":true
            }
        },
        "mandatory":{
            "type":"string",
            "xml":{
                "name":"Mandatory",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "xml":{
                "name":"CollectionExceptionConditionOID",
                "attribute":true
            }
        }
    }
}

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",
            "xml":{
                "name":"FormRef"
            },
            "items":{
                "$ref":"#/components/schemas/FormRef"
            }
        },
        "alias":{
            "type":"array",
            "xml":{
                "name":"Alias"
            },
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "repeating":{
            "type":"string",
            "xml":{
                "name":"Repeating",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"Type",
                "attribute":true
            },
            "enum":[
                "SCHEDULED",
                "UNSCHEDULED",
                "COMMON"
            ]
        },
        "category":{
            "type":"string",
            "xml":{
                "name":"Category",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"StudyEventDef",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Alias

Type: array

Show Source

Array of: object Alias

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

Nested Schema : FormRef

Type: array

Show Source

Array of: object FormRef

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

Nested Schema : FormRef

Type: object

Show Source

collectionExceptionConditionOID: string
formOID: string
mandatory: string

Allowed Values: [ "YES", "NO" ]
orderNumber: integer

{
    "type":"object",
    "properties":{
        "formOID":{
            "type":"string",
            "xml":{
                "name":"FormOID",
                "attribute":true
            }
        },
        "orderNumber":{
            "type":"integer",
            "xml":{
                "name":"OrderNumber",
                "attribute":true
            }
        },
        "mandatory":{
            "type":"string",
            "xml":{
                "name":"Mandatory",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "xml":{
                "name":"CollectionExceptionConditionOID",
                "attribute":true
            }
        }
    }
}

400 Response

'Missing / invalid data'

Root Schema : DataHubResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested 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 : result

Type: object

Nested Schema : details

Type: object