Jump to

• Request
• Response

ODM extract for meta data

get

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

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

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training. This will retrieve all study versions currently in that mode container, plus the study versions that were archived from that mode container.
• studyId(required): string
  ID of the study

Query Parameters

• fromTimestamp: string
  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.
• includeCOExtensions: string
  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.
• limit: integer(int32)
  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.
• offset: integer(int32)
  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.
• studyVersion: string
  The version of the study to extract data from in the ODM Extract.
• studyVersionSummary: string
  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

• application/xml
• application/json

200 Response

Successful operation

400 Response

'Missing / invalid data'

Body ()

Root Schema : DataHubResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top