REST API for Clinical One Platform

Get randomization list

get

/ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/randlists

Retrieves a randomization list. This API version returns useSequenceNumber to identify whether a given randomization list has a Sequence Number or not.

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

minimizationLists: string

Integer property for type of rand list.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : RandListTO v5.0

Type: object

Title: RandListTO v5.0

Contains randomization list details.

Show Source

blockedBy: string

Randomizatyion list blocked by type of Randomization

Example: none,country,region,site
description: string

Description of randomization list

Example: Randomization list with demographic cohort
firstAssctdRandDesignSrcId: string (uuid)

Unique Id for the first associated randomization design.
firstAssctdStudyVersion: string (UUID)

Version of the first associated study

Example: 1.0.1
inUse: string

Is randomization list is in use

Example: n,y
isBlocked: string

Is randomization list for blocked algorithm

Example: n,y
isCohortBased: string

Is randomization cohort based

Example: n,y
isDynamic: string

Is randomization list dynamic

Example: n,y
isMinimization: string

Is randomization list for minimization randomization design

Example: n,y
isStratified: string

Is randomization list stratified

Example: n,y
lastAssctdRandDesignSrcId: string (uuid)

Unique Id for the last associated randomization design.
lastAssctdStudyVersion: string (UUID)

Version of the last associated study

Example: 1.0.1
name: string

Name of randomization list

Example: UPL_RL191_V1001
randListId: string (uuid)

Unique ID for randomization list.
useSequenceNumber: string

Does Randomisation List has Sequence Number

Example: n,y
versionEnd: string (date-time)

Version End
versionStart: string (date-time)

Version Start

{
    "title":"RandListTO v5.0",
    "type":"object",
    "properties":{
        "randListId":{
            "type":"string",
            "description":"Unique ID for randomization list.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"Name of randomization list",
            "example":"UPL_RL191_V1001"
        },
        "description":{
            "type":"string",
            "description":"Description of randomization list",
            "example":"Randomization list with demographic cohort"
        },
        "isStratified":{
            "type":"string",
            "description":"Is randomization list stratified",
            "example":"n,y"
        },
        "isBlocked":{
            "type":"string",
            "description":"Is randomization list for blocked algorithm",
            "example":"n,y"
        },
        "isDynamic":{
            "type":"string",
            "description":"Is randomization list dynamic",
            "example":"n,y"
        },
        "inUse":{
            "type":"string",
            "description":"Is randomization list is in use",
            "example":"n,y"
        },
        "blockedBy":{
            "type":"string",
            "description":"Randomizatyion list blocked  by type of Randomization",
            "example":"none,country,region,site"
        },
        "isCohortBased":{
            "type":"string",
            "description":"Is randomization cohort based",
            "example":"n,y"
        },
        "firstAssctdRandDesignSrcId":{
            "type":"string",
            "description":"Unique Id for the first associated randomization design.",
            "format":"uuid"
        },
        "firstAssctdStudyVersion":{
            "type":"string",
            "description":"Version of the first associated study",
            "format":"UUID",
            "example":"1.0.1"
        },
        "isMinimization":{
            "type":"string",
            "description":"Is randomization list for minimization randomization design",
            "example":"n,y"
        },
        "lastAssctdRandDesignSrcId":{
            "type":"string",
            "description":"Unique Id for the last associated randomization design.",
            "format":"uuid"
        },
        "lastAssctdStudyVersion":{
            "type":"string",
            "description":"Version of the last associated study",
            "format":"UUID",
            "example":"1.0.1"
        },
        "useSequenceNumber":{
            "type":"string",
            "description":"Does Randomisation List has Sequence Number",
            "example":"n,y"
        }
    },
    "description":"Contains randomization list details."
}

404 Response

Appears for invalid study ID or invalid study version.

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.