ODM extract for meta data

get

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

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

Request

Path Parameters
Query Parameters
  • 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.
  • 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.
  • 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.
  • 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.
  • The version of the study to extract data from in the ODM Extract.
  • 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.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ODM
Type: object
Show Source
Nested Schema : Study
Type: array
Show Source
Nested Schema : Study
Type: object
Show Source
Nested Schema : BasicDefinitions
Type: object
Show Source
Nested Schema : GlobalVariables
Type: object
Show Source
Nested Schema : metaDataVersion
Type: array
Show Source
Nested Schema : MeasurementUnit
Type: array
Show Source
Nested Schema : MeasurementUnit
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : Symbol
Type: object
Show Source
Nested Schema : Alias
Type: object
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : TranslatedText
Type: object
Show Source
Nested Schema : ProtocolName
Type: object
Show Source
Nested Schema : StudyDescription
Type: object
Show Source
Nested Schema : StudyName
Type: object
Show Source
Nested Schema : MetaDataVersion
Type: object
Show Source
Nested Schema : CodeList
Type: array
Show Source
Nested Schema : ConditionDef
Type: array
Show Source
Nested Schema : formDef
Type: array
Show Source
Nested Schema : ImputationMethod
Type: array
Show Source
Nested Schema : Include
Type: object
Show Source
Nested Schema : itemDef
Type: array
Show Source
Nested Schema : itemGroupDef
Type: array
Show Source
Nested Schema : MethodDef
Type: array
Show Source
Nested Schema : Presentation
Type: array
Show Source
Nested Schema : Protocol
Type: object
Show Source
Nested Schema : studyEventDef
Type: array
Show Source
Nested Schema : CodeList
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : codeListItem
Type: array
Show Source
Nested Schema : Description
Type: object
Show Source
Nested Schema : EnumeratedItem
Type: array
Show Source
Nested Schema : ExternalCodeList
Type: object
Show Source
Nested Schema : CodeListItem
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : Decode
Type: object
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : EnumeratedItem
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ConditionDef
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormalExpression
Type: array
Show Source
Nested Schema : FormalExpression
Type: object
Show Source
Nested Schema : FormDef
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ArchiveLayout
Type: array
Show Source
Nested Schema : ItemGroupRef
Type: array
Show Source
Nested Schema : ArchiveLayout
Type: object
Show Source
Nested Schema : ItemGroupRef
Type: object
Show Source
Nested Schema : ImputationMethod
Type: object
Show Source
Nested Schema : ItemDef
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : CodeListRef
Type: object
Show Source
Nested Schema : ExternalQuestion
Type: object
Show Source
Nested Schema : MeasurementUnitRef
Type: array
Show Source
Nested Schema : Question
Type: object
Show Source
Nested Schema : RangeCheck
Type: array
Show Source
Nested Schema : Role
Type: array
Show Source
Nested Schema : MeasurementUnitRef
Type: object
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : RangeCheck
Type: object
Show Source
Nested Schema : CheckValue
Type: array
Show Source
Nested Schema : ErrorMessage
Type: object
Show Source
Nested Schema : FormalExpression
Type: array
Show Source
Nested Schema : CheckValue
Type: object
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : Role
Type: object
Show Source
Nested Schema : ItemGroupDef
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ItemRef
Type: array
Show Source
Nested Schema : ItemRef
Type: object
Show Source
Nested Schema : MethodDef
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormalExpression
Type: array
Show Source
Nested Schema : Presentation
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : StudyEventRef
Type: array
Show Source
Nested Schema : StudyEventRef
Type: object
Show Source
Nested Schema : StudyEventDef
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormRef
Type: array
Show Source
Nested Schema : FormRef
Type: object
Show Source

400 Response

'Missing / invalid data'
Body ()
Root Schema : DataHubResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Back to Top