REST API for Clinical One Platform

Get Study Design dataset

post

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

Retrieves study design dataset based on dynamic query parameters. Right: DataCollectionDesignDatasetPost.

Request

Path Parameters

studyId(required): string
tenantId(required): string

Query Parameters

limit: integer(int32)
offset: integer(int32)

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

orderColumns: array orderColumns
selectColumns: array selectColumns
whereColumns: array whereColumns

{
    "type":"object",
    "properties":{
        "selectColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "whereColumns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryPredicate"
            }
        },
        "orderColumns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryOrder"
            }
        }
    }
}

Nested Schema : orderColumns

Type: array

Show Source

Array of: object QueryOrder

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/QueryOrder"
    }
}

Nested Schema : selectColumns

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : whereColumns

Type: array

Show Source

Array of: object QueryPredicate

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/QueryPredicate"
    }
}

Nested Schema : QueryOrder

Type: object

Show Source

columnName: string
sortOrder: string

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string"
        },
        "sortOrder":{
            "type":"string"
        }
    }
}

Nested Schema : QueryPredicate

Type: object

Show Source

columnName: string
operator: string
value: array value

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "value":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : value

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DataHubReportDto

Type: object

Show Source

columns: array columns
count: integer (int32)
data: array data
hasMore: string
limit: integer (int32)
offset: integer (int32)
totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "columns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "data":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : columns

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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