ODM extract for clinical data without hidden data
get
/ec-datahub-svc/rest/v7.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
This API is used to extract blinded clinical data (excluding hidden data) in the CDISC ODM-XML format. This extract includes subject, visit, item level, and query transactions. Additionally this version adds Screening Number as a new clinical one extension attribute at the subject level and includes visit date queries as transactions at the visit level. Note: If offset and limit parameters are used for pagination, the transactions will be grouped per subject.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string
ID of the study
Query Parameters
-
fileType: string
It accepts 'Snapshot' or 'Transactional' to indicate whether to include in the ODM Extract current data only (Snapshot) or incremental data changes with audit information (Transactional).
The default value is Transactional. -
fromTimestamp: string
It includes data in the ODM Extract after this timestamp. It accepts yyyy-MM-dd'T'HH:mm:ss.SSS'Z' date format. FromTimestamp and ToTimestamp parameters are based on the dh_timestamp and not on the Clinical One version start timestamp. dh_timestamp is the time when the transaction/value was loaded into Data Hub warehouse. The dh_timestamp value is used to ensure that all values from the database are displayed in the extract.
-
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 subjects, beginning with the offset, that you want to retrieve. Offset must be provided to use this parameter. For example, if you want to retrieve subjects 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 subject you want to start retrieving clinical data from. If provided, you also need to specify a value for the limit parameter.
-
toTimestamp: string
It includes data in the ODM Extract up until this timestamp. It accepts yyyy-MM-dd'T'HH:mm:ss.SSS'Z' date format. FromTimestamp and ToTimestamp parameters are based on the dh_timestamp and not on the Clinical One version start timestamp. dh_timestamp is the time when the transaction/value was loaded into Data Hub warehouse. The dh_timestamp value is used to ensure that all values from the database are displayed in the extract.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Successful operation
400 Response
'Missing / invalid data'
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object