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

Get metadata of a specified study ID and study version

get

/ec-designer-svc/rest/v1.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
Example:
[
    {
        "studyOID":"S123"
    }
]
Nested Schema : BasicDefinitions
Type: object
Root-level definitions for basic units and reference types in the ODM Study.
Show Source
Example:
{
    "unitDef":[
        {
            "unitOID":"U1"
        }
    ]
}
Nested Schema : GlobalVariables
Type: object
ODM GlobalVariables for a Study, providing human-readable study description and identifiers.
Show Source
Example:
{
    "studyName":{
        "value":"TESTSTUDY"
    }
}
Nested Schema : MetaDataVersion
Type: object
List of metadata versions for the study.
Show Source
Example:
[
    {
        "versionOID":"MDV1"
    }
]
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 : Symbol
Type: object
Symbol element for a MeasurementUnit.
Show Source
Example:
{
    "translatedText":[
        {
            "lang":"en",
            "value":"mg/dL"
        }
    ]
}
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : ProtocolName
Type: object
Protocol identifier/name for the ODM Study.
Show Source
Nested Schema : StudyDescription
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 : StudyName
Type: object
Human-readable display name for the ODM Study.
Show Source
Example:
{
    "value":"Sample Study"
}
Nested Schema : CodeList
Type: object
Code lists for data values
Show Source
Example:
[
    {
        "codeListOID":"CL1"
    }
]
Nested Schema : ConditionDef
Type: object
Condition definitions for logic
Show Source
Example:
[
    {
        "conditionOID":"C1"
    }
]
Nested Schema : FormDef
Type: object
Form definitions
Show Source
Example:
[
    {
        "formOID":"F1"
    }
]
Nested Schema : ImputationMethod
Type: object
Imputation methods
Show Source
Example:
[
    {
        "methodOID":"IM1"
    }
]
Nested Schema : Include
Type: object
Reference to parent include structure
Show Source
Example:
{
    "href":"/includes/INC123"
}
Nested Schema : ItemDef
Type: object
Item definitions
Show Source
Example:
[
    {
        "itemOID":"I1"
    }
]
Nested Schema : ItemGroupDef
Type: object
Item group definitions
Show Source
Example:
[
    {
        "groupOID":"IG1"
    }
]
Nested Schema : MethodDef
Type: object
Custom method definitions
Show Source
Example:
[
    {
        "methodOID":"M1"
    }
]
Nested Schema : Presentation
Type: object
Presentations used in eCRFs
Show Source
Example:
[
    {
        "presentationOID":"P1"
    }
]
Nested Schema : Protocol
Type: object
Protocol metadata for this study version
Show Source
Example:
{
    "protocolName":"PROT1"
}
Nested Schema : StudyEventDef
Type: object
Study event definitions
Show Source
Example:
[
    {
        "eventOID":"SE1"
    }
]
Nested Schema : Alias
Type: array
Show Source
Nested Schema : Description
Type: object
Item description details
Show Source
Example:
{
    "value":"desc"
}
Nested Schema : EnumeratedItem
Type: array
Show Source
Nested Schema : ExternalCodeList
Type: object
Show Source
Nested Schema : Items
Type: array
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":"SUBJID"
    }
]
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : EnumeratedItem
Type: object
Show Source
Nested Schema : Alias
Type: array
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: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormalExpression
Type: array
Show Source
Nested Schema : FormalExpression
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 : 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":"SUBJID"
    }
]
Nested Schema : CodeListRef
Type: object
Reference to code list
Show Source
Example:
{
    "codeListOID":"CL1"
}
Nested Schema : ExternalQuestion
Type: object
Additional question taken from external systems
Show Source
Example:
{
    "externalId":"Q1"
}
Nested Schema : ItemRef
Type: object
Item reference list
Show Source
Example:
[
    {
        "itemOID":"ITM2"
    }
]
Nested Schema : MeasurementUnitRef
Type: object
Measurement units for this item
Show Source
Example:
[
    {
        "unitOID":"U1"
    }
]
Nested Schema : Question
Type: object
The main study question
Show Source
Example:
{
    "text":"What is your height?"
}
Nested Schema : RangeCheck
Type: object
Validation range checks
Show Source
Example:
[
    {
        "checkOID":"RC1"
    }
]
Nested Schema : Role
Type: object
Item roles (reviewer, data entry, etc)
Show Source
Example:
[
    {
        "roleName":"DataEntry"
    }
]
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : CheckValue
Type: object
Check values for enforcing data validation range
Show Source
Example:
[
    {
        "value":"10"
    }
]
Nested Schema : ErrorMessage
Type: object
Error message details for validation error
Show Source
Example:
{
    "lang":"en",
    "value":"Error: out of range!"
}
Nested Schema : FormalExpression
Type: object
Formal expressions for advanced data validation
Show Source
Example:
[
    {
        "language":"XPath",
        "value":"@AGE > 18"
    }
]
Nested Schema : MeasurementUnitRef
Type: object
Measurement unit reference
Show Source
Example:
{
    "measurementUnitOID":"U1"
}
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ItemRef
Type: array
Show Source
Nested Schema : ItemRef
Type: object
Item reference list
Show Source
Example:
[
    {
        "itemOID":"ITM2"
    }
]
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormalExpression
Type: array
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
Referenced study events
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
Example:
[
    {
        "context":"CDASH",
        "name":"SCREEN"
    }
]
Nested Schema : FormRef
Type: object
Associated form references
Show Source
Example:
[
    {
        "formOID":"F1"
    }
]

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
  • 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
  • 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

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
  • 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
  • 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
Back to Top