Jump to

• Request
• Response

Get Datahub Metrics Details

get

/ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/metrics

API to retrieve Datahub metrics dataset containing study-level and operational metrics. You can find more details about the dataset on [Metrics dataset](https://docs.oracle.com/en/industries/life-sciences/clinical-one/analytics-information/dh-metrics-dataset.html).

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts design, test, active, or training.
• studyId(required): string(uuid)
  UUID for the study in uppercase hexadecimal format. Example: 0C7CBA3F70034C47947E2FAB086BFBF5

  Example:

  0C7CBA3F70034C47947E2FAB086BFBF5

• tenantId(required): string(uuid)
  UUID for the tenant in uppercase hexadecimal format. Example: EC942244BB30163BE053BEC44C64CF34

  Example:

  EC942244BB30163BE053BEC44C64CF34

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DataHubSingleReportDto

Type: object

Single report result of the dynamic query execution

Show Source

• columns: array columns
  Names of the columns included in each row
• data: array data
  Row data aligned with the columns list

{
    "type":"object",
    "properties":{
        "columns":{
            "type":"array",
            "description":"Names of the columns included in each row",
            "example":[
                "STUDY_TITLE",
                "STUDY_REFNAME",
                "STUDY_ID"
            ],
            "items":{
                "type":"string",
                "description":"Names of the columns included in each row",
                "example":"[\"STUDY_TITLE\",\"STUDY_REFNAME\",\"STUDY_ID\"]"
            }
        },
        "data":{
            "type":"array",
            "description":"Row data aligned with the columns list",
            "example":[
                "My study",
                "MY_STUDY",
                "E8230E450E844721A67F8EBFF71B160D"
            ],
            "items":{
                "type":"string",
                "description":"Row data aligned with the columns list",
                "example":"[\"My study\",\"MY_STUDY\",\"E8230E450E844721A67F8EBFF71B160D\"]"
            }
        }
    },
    "description":"Single report result of the dynamic query execution"
}

Nested Schema : columns

Type: array

Names of the columns included in each row

Show Source

• Array of: string
  Names of the columns included in each row

  Example: ["STUDY_TITLE","STUDY_REFNAME","STUDY_ID"]

{
    "type":"array",
    "description":"Names of the columns included in each row",
    "example":[
        "STUDY_TITLE",
        "STUDY_REFNAME",
        "STUDY_ID"
    ],
    "items":{
        "type":"string",
        "description":"Names of the columns included in each row",
        "example":"[\"STUDY_TITLE\",\"STUDY_REFNAME\",\"STUDY_ID\"]"
    }
}

Example:

[
    "STUDY_TITLE",
    "STUDY_REFNAME",
    "STUDY_ID"
]

Nested Schema : data

Type: array

Row data aligned with the columns list

Show Source

• Array of: string
  Row data aligned with the columns list

  Example: ["My study","MY_STUDY","E8230E450E844721A67F8EBFF71B160D"]

{
    "type":"array",
    "description":"Row data aligned with the columns list",
    "example":[
        "My study",
        "MY_STUDY",
        "E8230E450E844721A67F8EBFF71B160D"
    ],
    "items":{
        "type":"string",
        "description":"Row data aligned with the columns list",
        "example":"[\"My study\",\"MY_STUDY\",\"E8230E450E844721A67F8EBFF71B160D\"]"
    }
}

Example:

[
    "My study",
    "MY_STUDY",
    "E8230E450E844721A67F8EBFF71B160D"
]

Examples

Select an example DatahubMetricsReport

400 Response

'Missing / invalid data'

Body ()

Root Schema : DataHubResponse

Type: object

Standard response envelope containing status, optional result payload, optional error information and a version number.

Show Source

• errorData: object errorData
  Error details when status is error.
• result: object result
  Payload returned by the API when status is success.
• status: string
  Overall request processing status.

  Example: success
• version: integer (int32)
  Envelope version number.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall request processing status.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Payload returned by the API when status is success.",
            "example":{
                "message":"Operation succeeded"
            }
        },
        "errorData":{
            "type":"object",
            "description":"Error details when status is error.",
            "example":{
                "errorCode":"C1-003",
                "errorMessage":"Validation failed",
                "details":{
                    "field":"limit",
                    "message":"limit must be >= 1"
                }
            }
        },
        "version":{
            "type":"integer",
            "description":"Envelope version number.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Standard response envelope containing status, optional result payload, optional error information and a version number."
}

Nested Schema : errorData

Type: object

Error details when status is error.

Example:

{
    "errorCode":"C1-003",
    "errorMessage":"Validation failed",
    "details":{
        "field":"limit",
        "message":"limit must be >= 1"
    }
}

Nested Schema : result

Type: object

Payload returned by the API when status is success.

Example:

{
    "message":"Operation succeeded"
}

Examples

Select an example ErrorResponseData

Back to Top