1. REST API for Clinical One Platform
  2. Tasks
  3. Designer
  4. Study APIs
  5. Study Metadata APIs
  6. v2.0

Get metadata of a specified study ID and study version

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
Nested Schema : Study
Type: object
ODM Study object
Show Source
Nested Schema : BasicDefinitions10
Type: object
Root-level definitions for basic units and reference types in the ODM Study.
Show Source
Nested Schema : GlobalVariables10
Type: object
ODM GlobalVariables for a Study, providing human-readable study description and identifiers.
Show Source
Nested Schema : MetaDataVersion
Type: object
Represents the metadata about the study
Show Source
Nested Schema : MeasurementUnit
Type: object
A measurement unit reference used in study forms, such as mg/dL.
Show Source
Nested Schema : Alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : Symbol10
Type: object
Symbol element for a MeasurementUnit.
Show Source
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : ProtocolName10
Type: object
Protocol identifier/name for the ODM Study.
Show Source
Nested Schema : StudyDescription10
Type: object
Free-text description of the ODM Study.
Show Source
  • Free-text description of the Study.
    Example: Phase 3, double blind, randomized clinical study in Diabetes.
Nested Schema : StudyName10
Type: object
Human-readable display name for the ODM Study.
Show Source
Nested Schema : codeList
Type: object
Code list definition including items or external mappings.
Show Source
Nested Schema : conditionDef
Type: object
Condition definition containing formal expressions and metadata.
Show Source
Nested Schema : formDef
Type: object
Form definition containing item group references, archive layouts and metadata.
Show Source
Nested Schema : imputationMethod
Type: object
Imputation method definition with value and identifier.
Show Source
  • Imputation method object identifier
    Example: a4a7124a-0056-4fb5-9a7e-4a1b0068a966.1_8_0_29
  • Imputation method value
    Example: MeanImputation
Nested Schema : Include10
Type: object
Includes the metadata about the study version
Show Source
Nested Schema : itemDef
Type: object
Item definition including question, code list, range checks and metadata.
Show Source
Nested Schema : itemGroupDef
Type: object
ItemGroup definition containing item references and metadata.
Show Source
Nested Schema : methodDef
Type: object
Method definition containing formal expressions and metadata.
Show Source
Nested Schema : presentation
Type: object
Presentation metadata including value, identifier and language.
Show Source
Nested Schema : Protocol10
Type: object
Protocol metadata
Show Source
Nested Schema : studyEventDef
Type: object
Study Event Def data
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : codeListItem
Type: object
Represents a single code list item with decode and metadata.
Show Source
Nested Schema : Description10
Type: object
Description DTO having information on the translated text
Show Source
Nested Schema : enumeratedItem
Type: object
Enumerated item value with optional ordering and aliases.
Show Source
Nested Schema : ExternalCodeList1
Type: object
Reference to an external dictionary-based code list.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : Decode1
Type: object
Decoded text for a code list item with translations.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : formalExpression
Type: object
Formal expression used for validation.
Show Source
Nested Schema : alias
Type: array
Aliases for the form
Show Source
Nested Schema : archiveLayout
Type: array
Archive layouts defined for this form
Show Source
Nested Schema : itemGroupRef
Type: array
Item group references for this form
Show Source
Nested Schema : Alias1
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : ArchiveLayout1
Type: object
Archive layout metadata for a form.
Show Source
Nested Schema : ItemGroupRef1
Type: object
Reference to an ItemGroup within a form.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : CodeListRef1
Type: object
Reference to a CodeList by its OID.
Show Source
  • OID of the referenced code list
    Example: c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : ExternalQuestion1
Type: object
External question reference details.
Show Source
Nested Schema : itemRef
Type: object
Reference to an Item within an ItemGroup.
Show Source
Nested Schema : measurementUnitRef
Type: object
Data captured for a Measurement Unit
Show Source
Nested Schema : Question1
Type: object
Question containing translated display text.
Show Source
Nested Schema : rangeCheck
Type: object
Range check configuration for item validation.
Show Source
Nested Schema : role
Type: object
Represents the role associated with an item or definition.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : checkValue
Type: object
A value used within a range validation.
Show Source
Nested Schema : ErrorMessage1
Type: object
Error message details for validation failures.
Show Source
Nested Schema : formalExpression
Type: object
Formal expression used for validation.
Show Source
Nested Schema : MeasurementUnitRef1
Type: object
Data captured for a Measurement Unit
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : alias
Type: array
Aliases for the ItemGroup
Show Source
Nested Schema : itemRef
Type: array
References to Items within this ItemGroup
Show Source
Nested Schema : ItemRef1
Type: object
Reference to an Item within an ItemGroup.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : formalExpression
Type: object
Formal expression used for validation.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Example:
[
    {
        "context":"CDASH",
        "name":"PROTID"
    }
]
Nested Schema : studyEventRef
Type: object
Study Event Ref data
Show Source
Example:
[
    {
        "eventOID":"SE1"
    }
]
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : formRef
Type: object
FormRef metadata
Show Source

404 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId
Back to Top