REST API for Clinical One Platform

~~[Deprecated]: V1.0~~

post

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

Deprecated: Use latest version instead. Retrieves data collection design data set based on dynamic query parameters. Right: [DataCollectionDesignDatasetPost](https://docs.oracle.com/en/industries/life-sciences/clinical-one/analytics-information/permissions-access-analytics-datasets.html). You can find more details about the dataset on [Study Design Dataset](https://docs.oracle.com/en/industries/life-sciences/clinical-one/analytics-information/study-design-dataset.html).

Request

Path Parameters

studyId(required): string

UUID for the study in uppercase hexadecimal format. Example: 0C7CBA3F70034C47947E2FAB086BFBF5
tenantId(required): string

UUID for the tenant in uppercase hexadecimal format. Example: EC942244BB30163BE053BEC44C64CF34

Query Parameters

limit: integer(int32)

Minimum Value: 0

The maximum number of records to return for the visits, forms, and items for each study version.
offset: integer(int32)

Minimum Value: 0

The number of records to skip before starting to return the visits, forms, and items for each study version.

Supported Media Types

application/json

Root Schema : schema

Type: object

Dynamic query for DataHub design dataset specifying selected columns, filter predicates and sort order

Show Source

orderColumns: array orderColumns

Sorting to apply on the result set
selectColumns: array selectColumns

Columns to include in the result set
whereColumns: array whereColumns

Filter predicates to apply when querying the dataset

{
    "type":"object",
    "properties":{
        "selectColumns":{
            "type":"array",
            "description":"Columns to include in the result set",
            "example":[
                "STUDY_VERSION",
                "STUDY_ID"
            ],
            "items":{
                "type":"string",
                "description":"Columns to include in the result set",
                "example":"[\"STUDY_VERSION\",\"STUDY_ID\"]"
            }
        },
        "whereColumns":{
            "type":"array",
            "description":"Filter predicates to apply when querying the dataset",
            "example":[
                {
                    "columnName":"STUDY_ID",
                    "operator":"=",
                    "value":[
                        "A86F2D0BB610404DB62D37AFA9C20B50"
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/QueryPredicate"
            }
        },
        "orderColumns":{
            "type":"array",
            "description":"Sorting to apply on the result set",
            "example":[
                {
                    "columnName":"VERSION_START",
                    "sortOrder":"ASC"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/QueryOrder"
            }
        }
    },
    "description":"Dynamic query for DataHub design dataset specifying selected columns, filter predicates and sort order"
}

Nested Schema : orderColumns

Type: array

Sorting to apply on the result set

Show Source

Array of: object QueryOrder

Sort instruction specifying a column and order direction

{
    "type":"array",
    "description":"Sorting to apply on the result set",
    "example":[
        {
            "columnName":"VERSION_START",
            "sortOrder":"ASC"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/QueryOrder"
    }
}

Example:

[
    {
        "columnName":"VERSION_START",
        "sortOrder":"ASC"
    }
]

Nested Schema : selectColumns

Type: array

Columns to include in the result set

Show Source

Array of: string

Columns to include in the result set

Example: ["STUDY_VERSION","STUDY_ID"]

{
    "type":"array",
    "description":"Columns to include in the result set",
    "example":[
        "STUDY_VERSION",
        "STUDY_ID"
    ],
    "items":{
        "type":"string",
        "description":"Columns to include in the result set",
        "example":"[\"STUDY_VERSION\",\"STUDY_ID\"]"
    }
}

Example:

[
    "STUDY_VERSION",
    "STUDY_ID"
]

Nested Schema : whereColumns

Type: array

Filter predicates to apply when querying the dataset

Show Source

Array of: object QueryPredicate

Predicate to filter dataset results by column, operator, and value

{
    "type":"array",
    "description":"Filter predicates to apply when querying the dataset",
    "example":[
        {
            "columnName":"STUDY_ID",
            "operator":"=",
            "value":[
                "A86F2D0BB610404DB62D37AFA9C20B50"
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/QueryPredicate"
    }
}

Example:

[
    {
        "columnName":"STUDY_ID",
        "operator":"=",
        "value":[
            "A86F2D0BB610404DB62D37AFA9C20B50"
        ]
    }
]

Nested Schema : QueryOrder

Type: object

Sort instruction specifying a column and order direction

Show Source

columnName: string

Column name to sort by

Example: VERSION_START
sortOrder: string

Sort order direction

Example: ASC

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"Column name to sort by",
            "example":"VERSION_START"
        },
        "sortOrder":{
            "type":"string",
            "description":"Sort order direction",
            "example":"ASC"
        }
    },
    "description":"Sort instruction specifying a column and order direction",
    "example":[
        {
            "columnName":"VERSION_START",
            "sortOrder":"ASC"
        }
    ]
}

Example:

[
    {
        "columnName":"VERSION_START",
        "sortOrder":"ASC"
    }
]

Nested Schema : QueryPredicate

Type: object

Predicate to filter dataset results by column, operator, and value

Show Source

columnName: string

Column name to filter on

Example: STUDY_ID
operator: string

Operator to apply for comparison

Example: =
value: array value

Values to use for the filter. For IN or BETWEEN, provide multiple values

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"Column name to filter on",
            "example":"STUDY_ID"
        },
        "operator":{
            "type":"string",
            "description":"Operator to apply for comparison",
            "example":"="
        },
        "value":{
            "type":"array",
            "description":"Values to use for the filter. For IN or BETWEEN, provide multiple values",
            "example":[
                "A86F2D0BB610404DB62D37AFA9C20B50"
            ],
            "items":{
                "type":"string",
                "description":"Values to use for the filter. For IN or BETWEEN, provide multiple values",
                "example":"[\"A86F2D0BB610404DB62D37AFA9C20B50\"]"
            }
        }
    },
    "description":"Predicate to filter dataset results by column, operator, and value",
    "example":[
        {
            "columnName":"STUDY_ID",
            "operator":"=",
            "value":[
                "A86F2D0BB610404DB62D37AFA9C20B50"
            ]
        }
    ]
}

Example:

[
    {
        "columnName":"STUDY_ID",
        "operator":"=",
        "value":[
            "A86F2D0BB610404DB62D37AFA9C20B50"
        ]
    }
]

Nested Schema : value

Type: array

Values to use for the filter. For IN or BETWEEN, provide multiple values

Show Source

Array of: string

Values to use for the filter. For IN or BETWEEN, provide multiple values

Example: ["A86F2D0BB610404DB62D37AFA9C20B50"]

{
    "type":"array",
    "description":"Values to use for the filter. For IN or BETWEEN, provide multiple values",
    "example":[
        "A86F2D0BB610404DB62D37AFA9C20B50"
    ],
    "items":{
        "type":"string",
        "description":"Values to use for the filter. For IN or BETWEEN, provide multiple values",
        "example":"[\"A86F2D0BB610404DB62D37AFA9C20B50\"]"
    }
}

Example:

[
    "A86F2D0BB610404DB62D37AFA9C20B50"
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DataHubReportDto

Type: object

Tabular report result of the dynamic query execution for the design dataset

Show Source

columns: array columns

Names of the columns included in each row
count: integer (int32)

Number of results returned in this page

Example: 2
data: array data

Row data aligned with the columns list. Each inner array represents one row.
hasMore: string

Indicates if more results are available beyond the current page

Example: false
limit: integer (int32)

Maximum number of rows requested per page

Example: 100
offset: integer (int32)

Zero-based offset applied to the result set

Example: 0
totalResults: integer (int32)

Total number of results across all pages

Example: 2

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"Indicates if more results are available beyond the current page",
            "example":"false"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of results across all pages",
            "format":"int32",
            "example":2
        },
        "count":{
            "type":"integer",
            "description":"Number of results returned in this page",
            "format":"int32",
            "example":2
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of rows requested per page",
            "format":"int32",
            "example":100
        },
        "offset":{
            "type":"integer",
            "description":"Zero-based offset applied to the result set",
            "format":"int32",
            "example":0
        },
        "columns":{
            "type":"array",
            "description":"Names of the columns included in each row",
            "example":[
                "FORM_OID",
                "ITEM_OID",
                "ITEM_NAME"
            ],
            "items":{
                "type":"string",
                "description":"Names of the columns included in each row",
                "example":"[\"FORM_OID\",\"ITEM_OID\",\"ITEM_NAME\"]"
            }
        },
        "data":{
            "type":"array",
            "description":"Row data aligned with the columns list. Each inner array represents one row.",
            "example":[
                [
                    "FORM001",
                    "ITEM001",
                    "Age"
                ],
                [
                    "FORM002",
                    "ITEM002",
                    "Weight"
                ]
            ],
            "items":{
                "type":"array",
                "description":"Row data aligned with the columns list. Each inner array represents one row.",
                "example":[
                    [
                        "FORM001",
                        "ITEM001",
                        "Age"
                    ],
                    [
                        "FORM002",
                        "ITEM002",
                        "Weight"
                    ]
                ],
                "items":{
                    "type":"string",
                    "description":"Row data aligned with the columns list. Each inner array represents one row.",
                    "example":"[[\"FORM001\",\"ITEM001\",\"Age\"],[\"FORM002\",\"ITEM002\",\"Weight\"]]"
                }
            }
        }
    },
    "description":"Tabular report result of the dynamic query execution for the design dataset"
}

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: ["FORM_OID","ITEM_OID","ITEM_NAME"]

{
    "type":"array",
    "description":"Names of the columns included in each row",
    "example":[
        "FORM_OID",
        "ITEM_OID",
        "ITEM_NAME"
    ],
    "items":{
        "type":"string",
        "description":"Names of the columns included in each row",
        "example":"[\"FORM_OID\",\"ITEM_OID\",\"ITEM_NAME\"]"
    }
}

Example:

[
    "FORM_OID",
    "ITEM_OID",
    "ITEM_NAME"
]

Nested Schema : data

Type: array

Row data aligned with the columns list. Each inner array represents one row.

Show Source

Array of: array items

Row data aligned with the columns list. Each inner array represents one row.

{
    "type":"array",
    "description":"Row data aligned with the columns list. Each inner array represents one row.",
    "example":[
        [
            "FORM001",
            "ITEM001",
            "Age"
        ],
        [
            "FORM002",
            "ITEM002",
            "Weight"
        ]
    ],
    "items":{
        "type":"array",
        "description":"Row data aligned with the columns list. Each inner array represents one row.",
        "example":[
            [
                "FORM001",
                "ITEM001",
                "Age"
            ],
            [
                "FORM002",
                "ITEM002",
                "Weight"
            ]
        ],
        "items":{
            "type":"string",
            "description":"Row data aligned with the columns list. Each inner array represents one row.",
            "example":"[[\"FORM001\",\"ITEM001\",\"Age\"],[\"FORM002\",\"ITEM002\",\"Weight\"]]"
        }
    }
}

Example:

[
    [
        "FORM001",
        "ITEM001",
        "Age"
    ],
    [
        "FORM002",
        "ITEM002",
        "Weight"
    ]
]

Nested Schema : items

Type: array

Row data aligned with the columns list. Each inner array represents one row.

Show Source

Array of: string

Row data aligned with the columns list. Each inner array represents one row.

Example: [["FORM001","ITEM001","Age"],["FORM002","ITEM002","Weight"]]

{
    "type":"array",
    "description":"Row data aligned with the columns list. Each inner array represents one row.",
    "example":[
        [
            "FORM001",
            "ITEM001",
            "Age"
        ],
        [
            "FORM002",
            "ITEM002",
            "Weight"
        ]
    ],
    "items":{
        "type":"string",
        "description":"Row data aligned with the columns list. Each inner array represents one row.",
        "example":"[[\"FORM001\",\"ITEM001\",\"Age\"],[\"FORM002\",\"ITEM002\",\"Weight\"]]"
    }
}

Example:

[
    [
        "FORM001",
        "ITEM001",
        "Age"
    ],
    [
        "FORM002",
        "ITEM002",
        "Weight"
    ]
]

400 Response

'Missing / invalid data'

Root 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 : details

Type: object