1. REST API for Clinical One Platform
  2. Tasks
  3. Data Hub
  4. v1.0

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
Query Parameters
  • It includes data in the ODM Extract after this timestamp. It accepts yyyy-MM-dd'T'HH:mm:ss.SSS'Z' date format.
    Example:
    2023-01-01T00:00:00.000Z
  • 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.
    Allowed Values: [ "true", "false" ]
    Example:
    true
  • 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.
    Allowed Values: [ "true", "false" ]
    Example:
    true
  • 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.
    Allowed Values: [ "true", "false" ]
    Example:
    true
  • Minimum Value: 1
    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.
    Example:
    100
  • Minimum Value: 0
    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.
    Example:
    0
  • It includes data in the ODM Extract up until this timestamp. It accepts yyyy-MM-dd'T'HH:mm:ss.SSS'Z' date format.
    Example:
    2023-12-31T23:59:59.999Z

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ODM
Type: object
ODM AdminData response root element containing administrative data and Clinical One specific metadata including pagination and extract attributes.
Show Source
Example:
<?xml version="1.0"?>
<ODM
	xmlns="http://www.cdisc.org/ns/odm/v1.3"
	xmlns:co="https://docs.oracle.com/en/industries/life-sciences/clinical-one/odm/extensions/v1"
	xmlns:ns0="http://www.w3.org/2000/09/xmldsig#" Description="STUDY01" FileType="Snapshot" FileOID="oracle/STUDY01/396A272FEA064663BB291B32D1FBA173" CreationDateTime="2025-11-03T13:21:53.238Z" ODMVersion="1.3.2" Originator="system" SourceSystem="Oracle Life Sciences Clinical One" SourceSystemVersion="AdminData API v1.0" co:studyMode="test" co:includeCOExtensions="true" co:fromTimestamp="2023-01-01T00:00:00Z" co:toTimestamp="2030-01-01T00:00:00Z" co:includeUsers="true" co:includeLocations="true">
	<AdminData>
		<Location OID="DATAHUB_AUT_Site2_Active" Name="DATAHUB_AUT_Site2_Active" LocationType="Site" co:LocationStatus="Active" co:LocationCountry="United States" co:LocationTimezone="Asia/Kolkata" co:InvestigatorFirstName="DatahubContact2" co:InvestigatorLastName="Tester2" co:GUID="3042285B08804CFF98F8F96B3626C843" co:Revision="2025-10-29T12:51:29.724Z">
			<MetaDataVersionRef StudyOID="STUDY01" MetaDataVersionOID="STUDY01v1.0.0.3" EffectiveDate="2025-10-29"></MetaDataVersionRef>
		</Location>
		<Location OID="DATAHUB_AUT_Site1_Active" Name="DATAHUB_AUT_Site1_Active" LocationType="Site" co:LocationStatus="Active" co:LocationCountry="United States" co:LocationTimezone="Asia/Kolkata" co:InvestigatorFirstName="DatahubContact1" co:InvestigatorLastName="Tester1" co:GUID="AE8D00C1DD324CA99B2125E38DDF1B14" co:Revision="2025-10-29T12:49:24.576Z">
			<MetaDataVersionRef StudyOID="STUDY01" MetaDataVersionOID="STUDY01v1.0.0.3" EffectiveDate="2025-10-29"></MetaDataVersionRef>
		</Location>
	</AdminData>
</ODM>
Nested Schema : AdminData
Type: object
List of AdminData sections with users, locations and related metadata.
Show Source
Nested Schema : location
Type: array
Show Source
Nested Schema : SignatureDef
Type: array
Show Source
Nested Schema : user
Type: array
Show Source
Nested Schema : Location
Type: object
Show Source
Nested Schema : MetaDataVersionRef
Type: array
Show Source
Nested Schema : MetaDataVersionRef
Type: object
Show Source
Nested Schema : SignatureDef
Type: object
Show Source
Nested Schema : LegalReason
Type: object
Show Source
Nested Schema : Meaning
Type: object
Show Source
Nested Schema : User
Type: object
Show Source
Nested Schema : Address
Type: array
Show Source
Nested Schema : Certificate
Type: array
Show Source
Nested Schema : DisplayName
Type: object
Show Source
Nested Schema : Email
Type: array
Show Source
Nested Schema : Fax
Type: array
Show Source
Nested Schema : FirstName
Type: object
Show Source
Nested Schema : FullName
Type: object
Show Source
Nested Schema : LastName
Type: object
Show Source
Nested Schema : LocationRef
Type: array
Show Source
Nested Schema : LoginName
Type: object
Show Source
Nested Schema : Organization
Type: object
Show Source
Nested Schema : Pager
Type: object
Show Source
Nested Schema : Phone
Type: array
Show Source
Nested Schema : Picture
Type: object
Show Source
Nested Schema : Address
Type: object
Show Source
Nested Schema : City
Type: object
Show Source
Nested Schema : Country
Type: object
Show Source
Nested Schema : OtherText
Type: object
Show Source
Nested Schema : PostalCode
Type: object
Show Source
Nested Schema : StateProv
Type: object
Show Source
Nested Schema : StreetName
Type: array
Show Source
Nested Schema : StreetName
Type: object
Show Source
Nested Schema : Certificate
Type: object
Digital certificate or identity for an ODM User.
Show Source
Nested Schema : Email
Type: object
Show Source
Nested Schema : Fax
Type: object
Show Source
Nested Schema : LocationRef
Type: object
Show Source
Nested Schema : Phone
Type: object
Phone number/contact entry for ODM User.
Show Source

400 Response

'Missing / invalid data'
Body ()
Root Schema : DataHubResponse
Type: object
Standard response envelope containing status, optional result payload, optional error information and a version number.
Show Source
Nested Schema : errorData
Type: object
Error details when status is error.
Example:
{
    "errorCode":"C1-003",
    "errorMessage":"Validation failed",
    "details":{
        "field":"limit",
        "message":"limit must be >= 1"
    }
}
Nested Schema : result
Type: object
Payload returned by the API when status is success.
Example:
{
    "message":"Operation succeeded"
}
Examples

Back to Top