REST API for Clinical One Platform

ODM extract for clinical data with hidden data

get

/ec-datahub-svc/rest/v9.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded

This API is used to extract unblinded clinical data (including hidden data) in the CDISC ODM-XML format. This extract includes subject, visit, item level, and query transactions. Additionally this version adds new clinical one extension attributes 'WithdrawalDate' at the subject level if Date of Withdrawal is entered, 'CompletionDate' at the subject level if Date of Completion is entered, 'EHRLinkStatus' at the subject level if the subject is linked to EHR and 'EHRImported' if the data is captured from EHR at the item level transactions. Note: If offset and limit parameters are used for pagination, the transactions will be grouped per subject.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string

ID of the study

Query Parameters

excludeHiddenData: string

Indicates whether to exclude or include hidden data from the ODM Extract. The API will only return what the user is authorized to see in either case. This value is used to limit the data returned if the requester has access to all data. It accepts true or false, or y or n. The default value is false.
fileType: string

It accepts 'Snapshot' or 'Transactional' to indicate whether to include in the ODM Extract current data only (Snapshot) or incremental data changes with audit information (Transactional).
The default value is Transactional.
fromTimestamp: string

It includes data in the ODM Extract after this timestamp. It accepts yyyy-MM-dd'T'HH:mm:ss.SSS'Z' date format. FromTimestamp and ToTimestamp parameters are based on the dh_timestamp and not on the Clinical One version start timestamp. dh_timestamp is the time when the transaction/value was loaded into Data Hub warehouse. The dh_timestamp value is used to ensure that all values from the database are displayed in the extract.
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 subjects, beginning with the offset, that you want to retrieve. Offset must be provided to use this parameter. For example, if you want to retrieve subjects 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 subject you want to start retrieving clinical data from. If provided, you also need to specify a value for the limit parameter.
toTimestamp: string

It includes data in the ODM Extract up until this timestamp. It accepts yyyy-MM-dd'T'HH:mm:ss.SSS'Z' date format. FromTimestamp and ToTimestamp parameters are based on the dh_timestamp and not on the Clinical One version start timestamp. dh_timestamp is the time when the transaction/value was loaded into Data Hub warehouse. The dh_timestamp value is used to ensure that all values from the database are displayed in the extract.

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)
clinicalData: array clinicalData
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
studyMode: string
studyVersion: string
studyVersionSummary: boolean
toDate: string (date-time)
totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "clinicalData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ClinicalData"
            }
        },
        "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 : clinicalData

Type: array

Show Source

Array of: object ClinicalData

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

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",
            "xml":{
                "name":"AuditRecords"
            },
            "items":{
                "$ref":"#/components/schemas/AuditRecords"
            }
        },
        "signatures":{
            "type":"array",
            "xml":{
                "name":"Signatures"
            },
            "items":{
                "$ref":"#/components/schemas/Signatures"
            }
        },
        "annotations":{
            "type":"array",
            "xml":{
                "name":"Annotations"
            },
            "items":{
                "$ref":"#/components/schemas/Annotations"
            }
        },
        "studyOID":{
            "type":"string",
            "xml":{
                "name":"StudyOID",
                "attribute":true
            }
        },
        "metaDataVersionOID":{
            "type":"string",
            "xml":{
                "name":"MetaDataVersionOID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"ClinicalData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Annotations

Type: array

Show Source

Array of: object Annotations

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

Nested Schema : AuditRecords

Type: array

Show Source

Array of: object AuditRecords

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

Nested Schema : Signatures

Type: array

Show Source

Array of: object Signatures

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

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

{
    "type":"array",
    "xml":{
        "name":"Annotation"
    },
    "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",
            "xml":{
                "name":"Flag"
            },
            "items":{
                "$ref":"#/components/schemas/Flag"
            }
        },
        "seqNum":{
            "type":"integer",
            "xml":{
                "name":"SeqNum",
                "attribute":true
            }
        },
        "transactionType":{
            "type":"string",
            "xml":{
                "name":"TransactionType",
                "attribute":true
            },
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "id":{
            "type":"string",
            "xml":{
                "name":"ID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"Annotation",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Comment

Type: object

Show Source

sponsorOrSite: string

Allowed Values: [ "SPONSOR", "SITE" ]
value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "sponsorOrSite":{
            "type":"string",
            "xml":{
                "name":"SponsorOrSite",
                "attribute":true
            },
            "enum":[
                "SPONSOR",
                "SITE"
            ]
        }
    }
}

Nested Schema : Flag

Type: array

Show Source

Array of: object Flag

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

Nested Schema : Flag

Type: object

Show Source

flagType: object FlagType
flagValue(required): object FlagValue

{
    "required":[
        "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",
            "xml":{
                "name":"CodeListOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : FlagValue

Type: object

Show Source

codeListOID: string
value: string

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

Nested Schema : AuditRecords

Type: object

Show Source

auditRecord: array AuditRecord

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

Nested Schema : AuditRecord

Type: array

Show Source

Array of: object AuditRecord

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

Nested Schema : AuditRecord

Type: object

Show Source

dateTimeStamp(required): object DateTimeStamp
editPoint: string

Allowed Values: [ "MONITORING", "DATA_MANAGEMENT", "DB_AUDIT" ]
id: string
locationRef(required): object LocationRef
reasonForChange: object ReasonForChange
sourceID: object SourceID
usedImputationMethod: string

Allowed Values: [ "YES", "NO" ]
userRef(required): object UserRef

{
    "required":[
        "dateTimeStamp",
        "locationRef",
        "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"
        },
        "editPoint":{
            "type":"string",
            "xml":{
                "name":"EditPoint",
                "attribute":true
            },
            "enum":[
                "MONITORING",
                "DATA_MANAGEMENT",
                "DB_AUDIT"
            ]
        },
        "usedImputationMethod":{
            "type":"string",
            "xml":{
                "name":"UsedImputationMethod",
                "attribute":true
            },
            "enum":[
                "YES",
                "NO"
            ]
        },
        "id":{
            "type":"string",
            "xml":{
                "name":"ID",
                "attribute":true
            }
        }
    }
}

Nested Schema : DateTimeStamp

Type: object

Show Source

value: string (date-time)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : LocationRef

Type: object

Show Source

locationOID: string

{
    "type":"object",
    "properties":{
        "locationOID":{
            "type":"string",
            "xml":{
                "name":"LocationOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : ReasonForChange

Type: object

Show Source

value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        }
    },
    "xml":{
        "name":"ReasonForChange",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

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",
            "xml":{
                "name":"UserOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : Signatures

Type: object

Show Source

signature: array Signature

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

Nested Schema : Signature

Type: array

Show Source

Array of: object Signature

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

Nested Schema : Signature

Type: object

Show Source

cryptoBindingManifest: object CryptoBindingManifest
dateTimeStamp(required): object DateTimeStamp
id: string
locationRef(required): object LocationRef
signatureRef(required): object SignatureRef
userRef(required): object UserRef

{
    "required":[
        "dateTimeStamp",
        "locationRef",
        "signatureRef",
        "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",
            "xml":{
                "name":"ID",
                "attribute":true
            }
        }
    }
}

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",
            "xml":{
                "name":"SignatureOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : SubjectData

Type: object

Show Source

annotation: array Annotation
auditRecord: object AuditRecord
investigatorRef: object InvestigatorRef
signature: object Signature
siteRef: object SiteRef
studyEventData: array studyEventData
subjectKey: string
transactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "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",
            "xml":{
                "name":"Annotation"
            },
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "studyEventData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventData"
            }
        },
        "subjectKey":{
            "type":"string",
            "xml":{
                "name":"SubjectKey",
                "attribute":true
            }
        },
        "transactionType":{
            "type":"string",
            "xml":{
                "name":"TransactionType",
                "attribute":true
            },
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    },
    "xml":{
        "name":"SubjectData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

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

Nested Schema : InvestigatorRef

Type: object

Show Source

userOID: string

{
    "type":"object",
    "properties":{
        "userOID":{
            "type":"string",
            "xml":{
                "name":"UserOID",
                "attribute":true
            }
        }
    }
}

Nested Schema : SiteRef

Type: object

Show Source

locationOID: string

{
    "type":"object",
    "properties":{
        "locationOID":{
            "type":"string",
            "xml":{
                "name":"LocationOID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SiteRef",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : studyEventData

Type: array

Show Source

Array of: object StudyEventData

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

Nested Schema : StudyEventData

Type: object

Show Source

annotation: array Annotation
auditRecord: object AuditRecord
formData: array formData
signature: object Signature
studyEventOID: string
studyEventRepeatKey: string
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",
            "xml":{
                "name":"Annotation"
            },
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "formData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormData"
            }
        },
        "studyEventOID":{
            "type":"string",
            "xml":{
                "name":"StudyEventOID",
                "attribute":true
            }
        },
        "studyEventRepeatKey":{
            "type":"string",
            "xml":{
                "name":"StudyEventRepeatKey",
                "attribute":true
            }
        },
        "transactionType":{
            "type":"string",
            "xml":{
                "name":"TransactionType",
                "attribute":true
            },
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    },
    "xml":{
        "name":"StudyEventData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

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

Nested Schema : formData

Type: array

Show Source

Array of: object FormData

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

Nested Schema : FormData

Type: object

Show Source

annotation: array Annotation
archiveLayoutRef: object ArchiveLayoutRef
auditRecord: object AuditRecord
formOID: string
formRepeatKey: string
itemGroupData: array itemGroupData
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"
        },
        "archiveLayoutRef":{
            "$ref":"#/components/schemas/ArchiveLayoutRef"
        },
        "annotation":{
            "type":"array",
            "xml":{
                "name":"Annotation"
            },
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "itemGroupData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupData"
            }
        },
        "formOID":{
            "type":"string",
            "xml":{
                "name":"FormOID",
                "attribute":true
            }
        },
        "formRepeatKey":{
            "type":"string",
            "xml":{
                "name":"FormRepeatKey",
                "attribute":true
            }
        },
        "transactionType":{
            "type":"string",
            "xml":{
                "name":"TransactionType",
                "attribute":true
            },
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    },
    "xml":{
        "name":"FormData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

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

Nested Schema : ArchiveLayoutRef

Type: object

Show Source

archiveLayoutOID: string

{
    "type":"object",
    "properties":{
        "archiveLayoutOID":{
            "type":"string",
            "xml":{
                "name":"ArchiveLayoutOID",
                "attribute":true
            }
        }
    }
}

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
itemDataGroup: array itemDataGroup
itemDataStarGroup: array itemDataStarGroup
itemGroupOID: string
itemGroupRepeatKey: string
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",
            "xml":{
                "name":"Annotation"
            },
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "itemDataGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemData"
            }
        },
        "itemDataStarGroup":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "itemGroupOID":{
            "type":"string",
            "xml":{
                "name":"ItemGroupOID",
                "attribute":true
            }
        },
        "itemGroupRepeatKey":{
            "type":"string",
            "xml":{
                "name":"ItemGroupRepeatKey",
                "attribute":true
            }
        },
        "transactionType":{
            "type":"string",
            "xml":{
                "name":"TransactionType",
                "attribute":true
            },
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    },
    "xml":{
        "name":"ItemGroupData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

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

Nested Schema : itemDataGroup

Type: array

Show Source

Array of: object ItemData

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

Nested Schema : itemDataStarGroup

Type: array

Show Source

Array of: object items

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

Nested Schema : ItemData

Type: object

Show Source

annotation: array Annotation
auditRecord: object AuditRecord
isNull: string

Allowed Values: [ "YES" ]
itemOID: string
measurementUnitRef: object MeasurementUnitRef
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",
            "xml":{
                "name":"Annotation"
            },
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "itemOID":{
            "type":"string",
            "xml":{
                "name":"ItemOID",
                "attribute":true
            }
        },
        "transactionType":{
            "type":"string",
            "xml":{
                "name":"TransactionType",
                "attribute":true
            },
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "isNull":{
            "type":"string",
            "xml":{
                "name":"IsNull",
                "attribute":true
            },
            "enum":[
                "YES"
            ]
        },
        "value":{
            "type":"string",
            "xml":{
                "name":"Value",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"ItemData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

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

Nested Schema : MeasurementUnitRef

Type: object

Show Source

measurementUnitOID: string

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

Nested Schema : items

Type: object

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