REST API for Clinical One Platform

Get unblinded randomization history for all subjects

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-rand-history

Retrieves unblinded randomization history for all subjects within the study. Rights: OrsSubjectVisitGet.

Request

Path Parameters

mode(required): string

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

ID of the study

Query Parameters

subjectId: string

ID of the subject

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : UnblindedRandomizationHistoryDTO v2.0

Type: object

Title: UnblindedRandomizationHistoryDTO v2.0

Contains unblinded randomization history.

Show Source

treatmentArms: array treatmentArms

{
    "title":"UnblindedRandomizationHistoryDTO v2.0",
    "type":"object",
    "properties":{
        "treatmentArms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationDetailsDTOV2"
            }
        }
    },
    "description":"Contains unblinded randomization history."
}

Nested Schema : treatmentArms

Type: array

Show Source

Array of: object RandomizationDetailsDTO v2.0

Title: RandomizationDetailsDTO v2.0

Contains randomization details.

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

Nested Schema : RandomizationDetailsDTO v2.0

Type: object

Title: RandomizationDetailsDTO v2.0

Contains randomization details.

Show Source

cohortId: string (uuid)

ID of the cohort
description: string

Randomization description

Example: RndA
externalTreatmentId: string

External Treatment Id.

Example: B1B8327AFAA6412287106192AB5984EF
id: string (uuid)

Randomization Id.
randNumber: number (double)

Randomization number.

Example: 5
randomizationDate: string (date-time)

Randomization date
rndStatusId: number (double)

Allowed Values: [ 1, 2, 3, 4, 5 ]

Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).

Example: 1
visitId: string (uuid)

ID of the visit

{
    "title":"RandomizationDetailsDTO v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization Id.",
            "format":"uuid"
        },
        "randNumber":{
            "type":"number",
            "description":"Randomization number.",
            "format":"double",
            "example":5
        },
        "randomizationDate":{
            "type":"string",
            "description":"Randomization date",
            "format":"date-time"
        },
        "rndStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).",
            "format":"double",
            "example":1,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        },
        "description":{
            "type":"string",
            "description":"Randomization description",
            "example":"RndA"
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"External Treatment Id.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "cohortId":{
            "type":"string",
            "description":"ID of the cohort",
            "format":"uuid"
        }
    },
    "description":"Contains randomization details."
}

404 Response

Invalid study ID or version. Or subject not found.

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.