Jump to

• Request
• Response

ODM extract for clinical data with hidden data

get

/ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded

This API is used to extract unblinded clinical data (including hidden data) in CDISC ODM-XML format. This extract only includes item level transactions. Clinical One version start timestamp is used to sort the values in the XML file. Clinical One version start timestamp is the time when the user entered the value/transaction occurred in Clinical One. Right: ODMClinicalDataHiddenGet.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string
  ID of the study

Query Parameters

• excludeHiddenData: string
  Indicates whether to exclude or include hidden data from the ODM Extract. The API will only return what the user is authorized to see in either case. This value is used to limit the data returned if the requester has access to all data. It accepts true or false, or y or n. The default value is false.
• fileType: string
  Indicates whether to include Snapshot or Transactional data in the ODM Extract. It accepts Snapshot or 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 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