REST API for Clinical One Platform

Get randomization list

get

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

Get randomization list, versioned to return useSequenceNumber to identify whether randList have Sequence Number.

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 v6.0

Type: object

Title: RandListTO v6.0

Contains randomization list details.

Show Source

blockedBy: string

Randomizatyion list blocked by type of Randomization

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

Does Randomisation List has cohortType

Example: Adaptive
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 v6.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"
        },
        "cohortType":{
            "type":"string",
            "description":"Does Randomisation List has cohortType",
            "example":"Adaptive"
        }
    },
    "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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object