1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Study APIs
  5. Study Metadata APIs
  6. Get metadata of a specified study ID and study version

V2.0

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/studyMetadata

Retrieves metadata for a specified study ID and study version.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
  • Study
    ODM Study container with global variables, optional basic definitions and one or more metadata versions describing the study structure.
Nested Schema : Study
Type: object
ODM Study container with global variables, optional basic definitions and one or more metadata versions describing the study structure.
Show Source
Nested Schema : BasicDefinitions
Type: object
Collection of units of measurement defined for this study.
Show Source
Nested Schema : GlobalVariables
Type: object
Global attributes of a study including human readable name, description and protocol identifier.
Show Source
Example:
<GlobalVariables><StudyName>STUDY01</StudyName><StudyDescription>Study01</StudyDescription><ProtocolName>STUDY01</ProtocolName></GlobalVariables>
Nested Schema : metaDataVersion
Type: array
One or more metadata versions that define the study design and data structures.
Show Source
Nested Schema : MeasurementUnit
Type: array
Units of measurement defined for this study.
Show Source
Nested Schema : MeasurementUnit
Type: object
Definition of a measurement unit including symbol and optional aliases.
Show Source
Example:
<MeasurementUnit OID="mg" Name="mg"><Symbol><TranslatedText>mg</TranslatedText></Symbol></MeasurementUnit>
Nested Schema : Alias
Type: array
Zero or more aliases for this unit.
Show Source
Nested Schema : Symbol
Type: object
Symbol for a measurement unit represented as a list of translated text entries.
Show Source
Example:
<Symbol><TranslatedText>mg</TranslatedText></Symbol>
Nested Schema : Alias
Type: object
Alternative naming context and value for an ODM element.
Show Source
Example:
<Alias Context="CDISC" Name="MG"/>
Nested Schema : TranslatedText
Type: array
Translated symbol values with language codes.
Show Source
Nested Schema : TranslatedText
Type: object
Localized text value with associated language code.
Show Source
Example:
<TranslatedText>mg</TranslatedText>
Nested Schema : ProtocolName
Type: object
Protocol identifier or shorthand title container.
Show Source
Example:
<ProtocolName>STUDY01</ProtocolName>
Nested Schema : StudyDescription
Type: object
Description of the study.
Show Source
  • Free text description content.
    Example: Randomized double-blind trial across 25 sites
Example:
<StudyDescription>Randomized double-blind trial across 25 sites</StudyDescription>
Nested Schema : StudyName
Type: object
Official study name.
Show Source
Example:
<StudyName>STUDY01</StudyName>
Nested Schema : MetaDataVersion
Type: object
Defines the study design and data structures including events, forms, items, code lists and methods.
Show Source
Example:
<MetaDataVersionOID="STUDY01v1.0.0.3"Name="STUDY01"co:StudyWid="25"co:GUID="0C7CBA3F70034C47947E2FAB086BFBF5"co:VersionStart="2025-10-29T14:37:54.638Z"><Protocol><StudyEventRefStudyEventOID="AE_DBB3A65B0A97454DAFEAEDDAB37395A1"OrderNumber="1"Mandatory="No"></StudyEventRef><StudyEventRefStudyEventOID="SCR_FD227430BECA4DECA5EA8B0E4DBE18CA"OrderNumber="2"Mandatory="Yes"></StudyEventRef><StudyEventRefStudyEventOID="Baseline_5DF278EB00F24820B9CEFE7BFD7A3078"OrderNumber="3"Mandatory="Yes"></StudyEventRef></Protocol><StudyEventDefOID="CBVisit2_AD5ACD1ED5E346129C6FABE4FA2E7DBE"Name="CBVISIT2"Repeating="No"Type="Scheduled"Category="ScheduleAbleVisit"co:StudyEventWid="248"co:GUID="AD5ACD1ED5E346129C6FABE4FA2E7DBE"co:VersionStart="2025-10-29T14:37:55.423Z"co:DelayDays="4"co:DelayHours="0"co:DelayWindowBeforeDays="2"co:DelayWindowBeforeHours="0"co:DelayWindowAfterDays="2"co:DelayWindowAfterHours="0"><FormRefFormOID="VITAL_SIGNS_FORM_TO_COLLECT_MEASUREMENT_3ADB1375C6714B8C97CA14AFA175D739"OrderNumber="1"Mandatory="Yes"></FormRef><FormRefFormOID="TWOSECTIONF1_19E7EE6903814132A9427E3E7A297107"OrderNumber="2"Mandatory="Yes"></FormRef></StudyEventDef><FormDefOID="DECISION_FORM_FOR_BRANCH_026521949ED24C69B0A82084832A3262"Name="DecisionFrom For Branch"Repeating="No"><ItemGroupRefOrderNumber="1"Mandatory="No"ItemGroupOID="IG_DATE_TIME_6ED56EC23ADD4841B8AC22ECB6205774"></ItemGroupRef><ItemGroupRefOrderNumber="2"Mandatory="Yes"ItemGroupOID="IG_ENABLE_DYNAMIC_VISIT_18936986318C4B00AAF89CDA492E6876"></ItemGroupRef></FormDef><ItemGroupDefOID="IG_LAB_FORM_XRAY_E98F15D6F16F425A8F0EC3B92C8B718F"Name="Lab Form - XRAY"Repeating="Yes"><ItemRefOrderNumber="1"Mandatory="No"ItemOID="LB_TEST_0267AEECE55441088516DA2C0E1B2EDC"></ItemRef><ItemRefOrderNumber="2"Mandatory="Yes"ItemOID="LB_RESULT_DE498EE22C884D55A50D285580AB674D"></ItemRef><ItemRefOrderNumber="3"Mandatory="No"ItemOID="LB_UNIT_00C6D2BF3F8B4178AAB25EBD3304E39E"></ItemRef><ItemRefOrderNumber="4"Mandatory="No"ItemOID="LB_LOW_RANGE_C8B8EEFE75F543299542C222ED94C28F"></ItemRef><ItemRefOrderNumber="5"Mandatory="No"ItemOID="LB_HIGH_RANGE_5CE74A4A9E97435B933B6C28645342AA"></ItemRef><ItemRefOrderNumber="6"Mandatory="No"ItemOID="NORMAL_TEXT_RESULT_746B6577A50C4D0A9DB53E1CD6B60551"></ItemRef></ItemGroupDef><ItemDefOID="SUBJECT_INITIALS_CF149710CBE24A6BB9266E52B5F5BA0F"Name="Subject_Initials"DataType="string"Length="3"co:ItemWid="618"co:GUID="CF149710CBE24A6BB9266E52B5F5BA0F"co:ItemVersionStart="2025-10-29T14:37:55.044Z"co:Precision="0"co:AllowFutureDate="No"><Question><TranslatedText>SubjectInitials</TranslatedText></Question></ItemDef><CodeListOID="GENDER_LAB_GENDER_0056B65135E24D8B960E3E9C4B68E280"Name="Gender"DataType="string"><CodeListItemCodedValue="C46"co:SelectionOID="GENDER_LAB_GENDER_0056B65135E24D8B960E3E9C4B68E280_GENDER_LA2"><Decode><TranslatedText>Female</TranslatedText></Decode></CodeListItem></CodeList></MetaDataVersion>
Nested Schema : CodeList
Type: array
Code lists used by item definitions.
Show Source
  • CodeList
    CodeList defining permissible values via CodeListItem/EnumeratedItem or referencing an external catalog.
Nested Schema : ConditionDef
Type: array
Conditional logic definitions used in the study.
Show Source
Nested Schema : formDef
Type: array
Form definitions contained in events.
Show Source
Nested Schema : ImputationMethod
Type: array
Imputation methods available to handle missing data.
Show Source
Nested Schema : Include
Type: object
Reference to another study and metadata version within ODM.
Show Source
Example:
{
    "studyOID":"S_0001",
    "metaDataVersionOID":"MDV_0001"
}
Nested Schema : itemDef
Type: array
Item definitions used across the study.
Show Source
  • ItemDef
    Item definition including data type, question text, range checks, code list reference, and metadata.
Nested Schema : itemGroupDef
Type: array
Item group definitions within forms.
Show Source
Nested Schema : MethodDef
Type: array
Method definitions for derivations or calculations.
Show Source
  • MethodDef
    Definition of a computation or derivation used within the ODM metadata, including description, formal expressions, aliases, and attributes.
Nested Schema : Presentation
Type: array
Presentation configurations for items and forms.
Show Source
Nested Schema : Protocol
Type: object
Study protocol definition including description and references to study events.
Show Source
Example:
{
    "description":{
        "translatedText":[
            {
                "value":"Protocol overview",
                "lang":"en"
            }
        ]
    },
    "studyEventRef":[
        {
            "studyEventOID":"SE_VISIT1",
            "orderNumber":1,
            "mandatory":"Yes",
            "collectionExceptionConditionOID":"COND_001"
        }
    ],
    "alias":[
        {
            "context":"SPONSOR",
            "name":"PROTO-001"
        }
    ]
}
Nested Schema : studyEventDef
Type: array
Definitions of study events or visits.
Show Source
Nested Schema : CodeList
Type: object
CodeList defining permissible values via CodeListItem/EnumeratedItem or referencing an external catalog.
Show Source
Example:
<CodeList OID="CL.AGE" Name="AgeUnits" DataType="text" SASFormatName="AGEFMT"><Description>Age units used for subject age</Description><CodeListItem CodedValue="YEARS"><Decode><TranslatedText xml:lang="en">Years</TranslatedText></Decode></CodeListItem><CodeListItem CodedValue="MONTHS"><Decode><TranslatedText xml:lang="en">Months</TranslatedText></Decode></CodeListItem><Alias Context="SDTM" Name="AGEU"/></CodeList>
Nested Schema : Alias
Type: array
Aliases that provide cross-references (e.g., SDTM variable names).
Show Source
Nested Schema : codeListItem
Type: array
Permissible values as coded items. Use when values are explicitly enumerated.
Show Source
Nested Schema : Description
Type: object
Localized description containing one or more translated text entries.
Show Source
Example:
<Description>
  <TranslatedText xml:lang="en">Protocol overview</TranslatedText>
</Description>
Nested Schema : EnumeratedItem
Type: array
Alternate representation of permissible values as enumerated items.
Show Source
Nested Schema : ExternalCodeList
Type: object
Reference to an external catalog-based code list.
Show Source
Nested Schema : CodeListItem
Type: object
Permissible values as coded items. Use when values are explicitly enumerated.
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
Localized description text entries.
Show Source
Nested Schema : EnumeratedItem
Type: object
Alternate representation of permissible values as enumerated items.
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ConditionDef
Type: object
Definition of a condition used within ODM to control logic, exceptions, or method execution.
Show Source
Example:
<ConditionDef OID="COND.WEIGHT_CHECK" Name="Weight Check">
  <Description>
    <TranslatedText xml:lang="en">Check weight-based dosing</TranslatedText>
  </Description>
  <FormalExpression Context="SAS">if (WEIGHT GT 0) then DOSE=WEIGHT*CONC; else DOSE=.;</FormalExpression>
  <Alias Context="bookmark" Name="WeightCheck"/>
</ConditionDef>
Nested Schema : Alias
Type: array
Optional aliases for the condition.
Show Source
Nested Schema : FormalExpression
Type: array
One or more formal expressions defining the condition logic.
Show Source
Nested Schema : FormalExpression
Type: object
Expression representing method logic in a specific execution context or language.
Show Source
  • Execution context or language for the expression.
    Example: SAS
  • Formal expression text.
    Example: if (WEIGHT GT 0) then DOSE=WEIGHT*CONC; else DOSE=.;
Example:
<FormalExpression Context="SAS">if (WEIGHT GT 0) then DOSE=WEIGHT*CONC; else DOSE=.;</FormalExpression>
Nested Schema : FormDef
Type: object
Form definition containing item group references, archive layout, and metadata.
Show Source
Example:
<FormDef OID="FRM.DEMO" Name="Demographics Form" Repeating="No"><Description>Form capturing demographic information</Description><ItemGroupRef ItemGroupOID="IG.DEMO" Mandatory="Yes" OrderNumber="1"/><ArchiveLayout Name="DefaultLayout"/><Alias Context="SDTM" Name="DM"/></FormDef>
Nested Schema : Alias
Type: array
Aliases providing cross-references, e.g., SDTM mapping.
Show Source
Nested Schema : ArchiveLayout
Type: array
Archive layout definitions for this form.
Show Source
Nested Schema : ItemGroupRef
Type: array
References to item groups included in this form.
Show Source
Nested Schema : ArchiveLayout
Type: object
Archive layout definitions for this form.
Show Source
Nested Schema : ItemGroupRef
Type: object
References to item groups included in this form.
Show Source
Nested Schema : ImputationMethod
Type: object
ImputationMethod element describing how missing values are imputed.
Show Source
  • Object identifier for the ImputationMethod element.
    Example: IMP001
  • Imputation method text content.
    Example: Mean Imputation
Example:
<ImputationMethod OID="IMP001">Mean Imputation</ImputationMethod>
Nested Schema : ItemDef
Type: object
Item definition including data type, question text, range checks, code list reference, and metadata.
Show Source
Example:
<ItemDef OID="IT.AGE" Name="Age" DataType="integer" Length="3" SignificantDigits="0" SASFieldName="AGE" SDSVarName="AGE" Origin="Collected" Comment="Age of subject"><Description>Subject age in years</Description><Question>What is the subject's age?</Question><MeasurementUnitRef MeasurementUnitOID="MU.YEARS"/><RangeCheck Comparator="GE" SoftHard="Soft"><CheckValue>0</CheckValue></RangeCheck><RangeCheck Comparator="LE" SoftHard="Soft"><CheckValue>130</CheckValue></RangeCheck><CodeListRef CodeListOID="CL.AGEU"/><Role>Demographics</Role><Alias Context="SDTM" Name="AGE"/></ItemDef>
Nested Schema : Alias
Type: array
Aliases providing cross-references, e.g., to SDTM.
Show Source
Nested Schema : CodeListRef
Type: object
Reference to a CodeList that constrains values for this item.
Show Source
Nested Schema : ExternalQuestion
Type: object
Optional external question metadata reference.
Show Source
Nested Schema : MeasurementUnitRef
Type: array
List of measurement units referenced by this item.
Show Source
Nested Schema : Question
Type: object
Primary question text associated with the ItemDef.
Show Source
Nested Schema : RangeCheck
Type: array
Validation constraints for values of this item.
Show Source
Nested Schema : Role
Type: array
Roles associated with this item.
Show Source
Nested Schema : MeasurementUnitRef
Type: object
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : RangeCheck
Type: object
Validation constraints for values of this item.
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
Roles associated with this item.
Show Source
Nested Schema : ItemGroupDef
Type: object
Item group definition aggregating item references, attributes, and metadata.
Show Source
Example:
<ItemGroupDef OID="IG.DEMO" Name="Demographics" Repeating="No" IsReferenceData="No" SASDatasetName="DM" Domain="DM" Origin="Collected" Role="Form" Purpose="CRF" Comment="Demographics group"><Description>Demographics item group</Description><ItemRef ItemOID="IT.AGE" Mandatory="Yes" OrderNumber="1"/><ItemRef ItemOID="IT.SEX" Mandatory="Yes" OrderNumber="2"/><Alias Context="SDTM" Name="DMIG"/></ItemGroupDef>
Nested Schema : Alias
Type: array
Aliases providing cross-references, e.g., to SDTM.
Show Source
Nested Schema : ItemRef
Type: array
References to items included in this group.
Show Source
Nested Schema : ITEMREF
Type: object
Show Source
Nested Schema : CONTROLREF
Type: object
Show Source
Nested Schema : MethodDef
Type: object
Definition of a computation or derivation used within the ODM metadata, including description, formal expressions, aliases, and attributes.
Show Source
Example:
<MethodDef OID="MD.METH001" Name="DoseComputation" Type="Computation">
  <Description>
    <TranslatedText xml:lang="en">Compute derived dose based on weight and concentration</TranslatedText>
  </Description>
  <FormalExpression Context="SAS">if (WEIGHT GT 0) then DOSE=WEIGHT*CONC; else DOSE=.;</FormalExpression>
 <Alias Context="CDISC" Name="DRVDose"/>
</MethodDef>
Nested Schema : Alias
Type: array
Aliases providing alternative names in different contexts.
Show Source
Nested Schema : FormalExpression
Type: array
One or more formal expressions describing the method logic and its execution context.
Show Source
Nested Schema : Presentation
Type: object
Presentation element containing display text and metadata.
Show Source
Example:
<Presentation OID="PRES001" xml:lang="en">Tablet, 50 mg</Presentation>
Nested Schema : Alias
Type: array
Optional aliases for the protocol.
Show Source
Nested Schema : StudyEventRef
Type: array
References to study events that constitute the schedule of assessments.
Show Source
Nested Schema : StudyEventRef
Type: object
Reference to a study event within the protocol schedule, including ordering and mandatory collection attributes.
Show Source
Example:
{
    "studyEventOID":"SE_VISIT1",
    "orderNumber":1,
    "mandatory":"Yes",
    "collectionExceptionConditionOID":"COND_001"
}
Nested Schema : StudyEventDef
Type: object
Study event definition containing form references, scheduling attributes, and metadata.
Show Source
Example:
<StudyEventDef OID="SE.VISIT1" Name="Visit 1" Repeating="No" Type="Scheduled" Category="Screening"><Description>Initial screening visit</Description><FormRef FormOID="FRM.DEMO" Mandatory="Yes" OrderNumber="1"/><Alias Context="SDTM" Name="SV"/></StudyEventDef>
Nested Schema : Alias
Type: array
Aliases providing cross-references (e.g., SDTM).
Show Source
Nested Schema : FormRef
Type: array
References to forms associated with this study event.
Show Source
Nested Schema : FORMREF
Type: object
Show Source
Nested Schema : SECTIONREF
Type: object
Show Source
Nested Schema : ITEMSETREF
Type: object
Show Source
Examples

404 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : Object
Type: object
Title: Object
Object with error details information.

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top