REST API for Clinical One Platform

Get randomization number

get

/ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers

Versioned to return sequenceNumber along with randomization number. Rights: OrsRandListGet and OrsUnblinded.

Request

Path Parameters

mode(required): string

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

ID of the randomization list
studyId(required): string(uuid)

ID of the study

Query Parameters

blockedBy: string(uuid)

ID of the entity which has blocked the randomization number
cohortId: string

ID of the cohort
groupId: string

ID of the group in a stratum
limit: string

Maximum number of records to display per page.

Default Value: 100
offset: string

An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

Default Value: 0
searchString(required): string

Search string
status: number

Status of the randomization number

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : RandNumberResponseV1.0

Type: object

Title: RandNumberResponseV1.0

Contains Random number response.

Show Source

count: integer (int64)

Total count of result
hasMore: boolean

Attribute describes if result set has more records

Example: true
limit: integer (int64)

Maximum number of records to display per page.
links: array links
offset: integer (int64)

An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

Example: 400
randNumbers: array randNumbers
totalResults: integer (int64)

Total number of entities in response

{
    "title":"RandNumberResponseV1.0",
    "type":"object",
    "properties":{
        "randNumbers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandNumbersTO4"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    },
    "description":"Contains Random number response."
}

Nested Schema : links

Type: array

Show Source

Array of: object RelLink

Object contains link detail.

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

Nested Schema : randNumbers

Type: array

Show Source

Array of: object RandNumbersTO V4.0

Title: RandNumbersTO V4.0

Contains Random number details.

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

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

href: string

Realtive URL
rel: string

link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

Nested Schema : RandNumbersTO V4.0

Type: object

Title: RandNumbersTO V4.0

Contains Random number details.

Show Source

blockingParamId: string

Unique Id of blocking parameter

Example: B1B8327AFAA6412287106192AB5984EF
blockingParamName: string

Blocking Parameter Name

Example: site
blockingParamValue: string

Blocking Parameter value

Example: Site1001
blockNumber: number (BigDecimal)

Block number

Example: 10
cohortId: string (uuid)

Unique Id for cohort.
cohortName: string

Cohort Name

Example: Demo Cohort 1001
externalTreatmentId: string

Treatment Name

Example: Treatment arm 1001
Minimization: object Minimization

Title: Minimization

Contains minimization details.
randNumber: number (BigDecimal)

Radomization number

Example: 10
randNumberId: string (uuid)

Unique Id for randomization number.
randStatusId: number (BigDecimal)

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: 10
randStatusKey: string

Allowed Values: [ "Unapproved", "Available", "Inactive", "Assigned", "Randomized in error" ]

Randomization status

Example: Assigned, Available
sequenceNumber: number

Title: sequenceNumber

sequenceNumber
statumId: string (uuid)

Unique Id for stratum
stratumName: string

Stratum Name

Example: Male, Female
subjectId: string (uuid)

ID of the subject
subjectNumber: string

Subject number

Example: S1001
treatmentId: string (uuid)

Unique Id for treatment arm.
versionEnd: string (date-time)

Version End
versionStart: string (date-time)

Version Start

{
    "title":"RandNumbersTO V4.0",
    "type":"object",
    "properties":{
        "randNumberId":{
            "type":"string",
            "description":"Unique Id for randomization number.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "randNumber":{
            "type":"number",
            "description":"Radomization number",
            "format":"BigDecimal",
            "example":10
        },
        "blockNumber":{
            "type":"number",
            "description":"Block number",
            "format":"BigDecimal",
            "example":10
        },
        "randStatusId":{
            "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":"BigDecimal",
            "example":10,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        },
        "randStatusKey":{
            "type":"string",
            "description":"Randomization status",
            "example":"Assigned, Available",
            "enum":[
                "Unapproved",
                "Available",
                "Inactive",
                "Assigned",
                "Randomized in error"
            ]
        },
        "treatmentId":{
            "type":"string",
            "description":"Unique Id for treatment arm.",
            "format":"uuid"
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"Treatment Name",
            "example":"Treatment arm 1001 "
        },
        "blockingParamName":{
            "type":"string",
            "description":"Blocking Parameter Name",
            "example":"site"
        },
        "blockingParamId":{
            "type":"string",
            "description":"Unique Id of blocking parameter",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "blockingParamValue":{
            "type":"string",
            "description":"Blocking Parameter value",
            "example":"Site1001"
        },
        "subjectId":{
            "type":"string",
            "description":"ID  of the subject",
            "format":"uuid"
        },
        "subjectNumber":{
            "type":"string",
            "description":"Subject number",
            "example":"S1001"
        },
        "statumId":{
            "type":"string",
            "description":"Unique Id for stratum",
            "format":"uuid"
        },
        "stratumName":{
            "type":"string",
            "description":"Stratum Name",
            "example":"Male, Female"
        },
        "cohortId":{
            "type":"string",
            "description":"Unique Id for cohort.",
            "format":"uuid"
        },
        "cohortName":{
            "type":"string",
            "description":"Cohort Name",
            "example":"Demo Cohort 1001"
        },
        "Minimization":{
            "$ref":"#/components/schemas/MinimizationTO"
        },
        "sequenceNumber":{
            "title":"sequenceNumber",
            "type":"number",
            "description":"sequenceNumber"
        }
    },
    "description":"Contains Random number details."
}

Nested Schema : Minimization

Type: object

Title: Minimization

Contains minimization details.

Show Source

groups: array groups
probabilityFactor: string

Probabilty factor for a given random number

Example: 0.23

{
    "title":"Minimization",
    "type":"object",
    "properties":{
        "probabilityFactor":{
            "type":"string",
            "description":"Probabilty factor for a given random number",
            "example":"0.23"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/groups"
            }
        }
    },
    "description":"Contains minimization details."
}

Nested Schema : groups

Type: array

Show Source

Array of: object groups

List of minimization groups

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

Nested Schema : groups

Type: object

List of minimization groups

Show Source

probabilityFactor: string

Probabilty factor for a given random number

Example: 0.23

{
    "type":"object",
    "properties":{
        "probabilityFactor":{
            "type":"string",
            "description":"Probabilty factor for a given random number",
            "example":"0.23"
        }
    },
    "description":"List of minimization groups"
}

404 Response

Appears for invalid study ID, invalid study version, or if a randomization list isn't 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.