REST API for Clinical One Platform

ODM extract for admin data

get

/ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/admin

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

Request

Path Parameters

mode(required): string

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

ID of the study

Query Parameters

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.
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.
includeLocations: string

Indicates whether to include Clinical One Sites data for the study in the ODM Extract. It accepts true or false. The default value is true.
includeUsers: string

Indicates whether to include Clinical One User data for the study in the ODM Extract. It accepts true or false. The default value is true.
limit: integer(int32)

The number of users/sites, beginning with the offset, that you want to retrieve. Offset must be provided to use this parameter. For example, if you want to retrieve users 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 user/site you want to start retrieving admin 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.

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

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

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

Type: array

Show Source

Array of: object AdminData

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

Nested Schema : AdminData

Type: object

Show Source

location: array location
signatureDef: array SignatureDef
studyOID: string
user: array user

{
    "type":"object",
    "properties":{
        "user":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/User"
            }
        },
        "location":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Location"
            }
        },
        "signatureDef":{
            "type":"array",
            "xml":{
                "name":"SignatureDef"
            },
            "items":{
                "$ref":"#/components/schemas/SignatureDef"
            }
        },
        "studyOID":{
            "type":"string",
            "xml":{
                "name":"StudyOID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"AdminData",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : location

Type: array

Show Source

Array of: object Location

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

Nested Schema : SignatureDef

Type: array

Show Source

Array of: object SignatureDef

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

Nested Schema : user

Type: array

Show Source

Array of: object User

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

Nested Schema : Location

Type: object

Show Source

locationType: string

Allowed Values: [ "SPONSOR", "SITE", "CRO", "LAB", "OTHER" ]
metaDataVersionRef(required): array MetaDataVersionRef
name: string
oid: string

{
    "required":[
        "metaDataVersionRef"
    ],
    "type":"object",
    "properties":{
        "metaDataVersionRef":{
            "type":"array",
            "xml":{
                "name":"MetaDataVersionRef"
            },
            "items":{
                "$ref":"#/components/schemas/MetaDataVersionRef"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"Name",
                "attribute":true
            }
        },
        "locationType":{
            "type":"string",
            "xml":{
                "name":"LocationType",
                "attribute":true
            },
            "enum":[
                "SPONSOR",
                "SITE",
                "CRO",
                "LAB",
                "OTHER"
            ]
        }
    },
    "xml":{
        "name":"Location",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : MetaDataVersionRef

Type: array

Show Source

Array of: object MetaDataVersionRef

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

Nested Schema : MetaDataVersionRef

Type: object

Show Source

effectiveDate: string (date-time)
metaDataVersionOID: string
studyOID: string

{
    "type":"object",
    "properties":{
        "studyOID":{
            "type":"string",
            "xml":{
                "name":"StudyOID",
                "attribute":true
            }
        },
        "metaDataVersionOID":{
            "type":"string",
            "xml":{
                "name":"MetaDataVersionOID",
                "attribute":true
            }
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"EffectiveDate",
                "attribute":true
            }
        }
    }
}

Nested Schema : SignatureDef

Type: object

Show Source

legalReason(required): object LegalReason
meaning(required): object Meaning
methodology: string

Allowed Values: [ "DIGITAL", "ELECTRONIC" ]
oid: string

{
    "required":[
        "legalReason",
        "meaning"
    ],
    "type":"object",
    "properties":{
        "meaning":{
            "$ref":"#/components/schemas/Meaning"
        },
        "legalReason":{
            "$ref":"#/components/schemas/LegalReason"
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "methodology":{
            "type":"string",
            "xml":{
                "name":"Methodology",
                "attribute":true
            },
            "enum":[
                "DIGITAL",
                "ELECTRONIC"
            ]
        }
    }
}

Nested Schema : LegalReason

Type: object

Show Source

value: string

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

Nested Schema : Meaning

Type: object

Show Source

value: string

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

Nested Schema : User

Type: object

Show Source

address: array Address
certificate: array Certificate
displayName: object DisplayName
email: array Email
fax: array Fax
firstName: object FirstName
fullName: object FullName
lastName: object LastName
locationRef: array LocationRef
loginName: object LoginName
oid: string
organization: object Organization
pager: object Pager
phone: array Phone
picture: object Picture
userType: string

Allowed Values: [ "SPONSOR", "INVESTIGATOR", "LAB", "OTHER" ]

{
    "type":"object",
    "properties":{
        "loginName":{
            "$ref":"#/components/schemas/LoginName"
        },
        "displayName":{
            "$ref":"#/components/schemas/DisplayName"
        },
        "fullName":{
            "$ref":"#/components/schemas/FullName"
        },
        "firstName":{
            "$ref":"#/components/schemas/FirstName"
        },
        "lastName":{
            "$ref":"#/components/schemas/LastName"
        },
        "organization":{
            "$ref":"#/components/schemas/Organization"
        },
        "address":{
            "type":"array",
            "xml":{
                "name":"Address"
            },
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "email":{
            "type":"array",
            "xml":{
                "name":"Email"
            },
            "items":{
                "$ref":"#/components/schemas/Email"
            }
        },
        "picture":{
            "$ref":"#/components/schemas/Picture"
        },
        "pager":{
            "$ref":"#/components/schemas/Pager"
        },
        "fax":{
            "type":"array",
            "xml":{
                "name":"Fax"
            },
            "items":{
                "$ref":"#/components/schemas/Fax"
            }
        },
        "phone":{
            "type":"array",
            "xml":{
                "name":"Phone"
            },
            "items":{
                "$ref":"#/components/schemas/Phone"
            }
        },
        "locationRef":{
            "type":"array",
            "xml":{
                "name":"LocationRef"
            },
            "items":{
                "$ref":"#/components/schemas/LocationRef"
            }
        },
        "certificate":{
            "type":"array",
            "xml":{
                "name":"Certificate"
            },
            "items":{
                "$ref":"#/components/schemas/Certificate"
            }
        },
        "oid":{
            "type":"string",
            "xml":{
                "name":"OID",
                "attribute":true
            }
        },
        "userType":{
            "type":"string",
            "xml":{
                "name":"UserType",
                "attribute":true
            },
            "enum":[
                "SPONSOR",
                "INVESTIGATOR",
                "LAB",
                "OTHER"
            ]
        }
    },
    "xml":{
        "name":"User",
        "namespace":"http://www.cdisc.org/ns/odm/v1.3"
    }
}

Nested Schema : Address

Type: array

Show Source

Array of: object Address

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

Nested Schema : Certificate

Type: array

Show Source

Array of: object Certificate

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

Nested Schema : DisplayName

Type: object

Show Source

value: string

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

Nested Schema : Email

Type: array

Show Source

Array of: object Email

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

Nested Schema : Fax

Type: array

Show Source

Array of: object Fax

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

Nested Schema : FirstName

Type: object

Show Source

value: string

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

Nested Schema : FullName

Type: object

Show Source

value: string

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

Nested Schema : LastName

Type: object

Show Source

value: string

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

Nested Schema : LocationRef

Type: array

Show Source

Array of: object LocationRef

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

Nested Schema : LoginName

Type: object

Show Source

value: string

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

Nested Schema : Organization

Type: object

Show Source

value: string

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

Nested Schema : Pager

Type: object

Show Source

value: string

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

Nested Schema : Phone

Type: array

Show Source

Array of: object Phone

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

Nested Schema : Picture

Type: object

Show Source

imageType: string
pictureFileName: string

{
    "type":"object",
    "properties":{
        "pictureFileName":{
            "type":"string",
            "xml":{
                "name":"PictureFileName",
                "attribute":true
            }
        },
        "imageType":{
            "type":"string",
            "xml":{
                "name":"ImageType",
                "attribute":true
            }
        }
    }
}

Nested Schema : Address

Type: object

Show Source

city: object City
country: object Country
otherText: object OtherText
postalCode: object PostalCode
stateProv: object StateProv
streetName: array StreetName

{
    "type":"object",
    "properties":{
        "streetName":{
            "type":"array",
            "xml":{
                "name":"StreetName"
            },
            "items":{
                "$ref":"#/components/schemas/StreetName"
            }
        },
        "city":{
            "$ref":"#/components/schemas/City"
        },
        "stateProv":{
            "$ref":"#/components/schemas/StateProv"
        },
        "country":{
            "$ref":"#/components/schemas/Country"
        },
        "postalCode":{
            "$ref":"#/components/schemas/PostalCode"
        },
        "otherText":{
            "$ref":"#/components/schemas/OtherText"
        }
    }
}

Nested Schema : City

Type: object

Show Source

value: string

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

Nested Schema : Country

Type: object

Show Source

value: string

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

Nested Schema : OtherText

Type: object

Show Source

value: string

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

Nested Schema : PostalCode

Type: object

Show Source

value: string

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

Nested Schema : StateProv

Type: object

Show Source

value: string

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

Nested Schema : StreetName

Type: array

Show Source

Array of: object StreetName

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

Nested Schema : StreetName

Type: object

Show Source

value: string

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

Nested Schema : Certificate

Type: object

Show Source

value: string

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

Nested Schema : Email

Type: object

Show Source

value: string

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

Nested Schema : Fax

Type: object

Show Source

value: string

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

Nested Schema : LocationRef

Type: object

Show Source

locationOID: string

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

Nested Schema : Phone

Type: object

Show Source

value: string

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

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