Jump to

• Request
• Response

Get blinded visit details

post

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

Retrieves blinded visit details based on dynamic query parameters. Right: BlindedSubjectEventDatasetPost.

Request

Path Parameters

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

Query Parameters

• limit(required): integer(int32)
• offset(required): integer(int32)

Supported Media Types

• application/json

Request Body - 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

400 Response

'Missing / invalid data'

Body ()

Root Schema : ErrorResponseData_ORS

Type: object

Title: ErrorResponseData_ORS

Response object to represent errors.

Show Source

• details: object details
  Detail of error
• errorCode: string
  Error code in error response

  Example: DESIGN_NOT_FOUND,JSON-004
• errorMessage: string
  Error message in error response

  Example: Design not found, Validation error

{
    "title":"ErrorResponseData_ORS",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code in error response",
            "example":"DESIGN_NOT_FOUND,JSON-004"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message in error response",
            "example":"Design not found, Validation error"
        },
        "details":{
            "type":"object",
            "description":"Detail of error"
        }
    },
    "description":"Response object to represent errors."
}

Nested Schema : details

Type: object

Detail of error

Back to Top