REST API for Clinical One Platform

Get randomization design list

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns

Retrieves a randomization design list. Rights: OrsRandListGet, OrsUnblinded.

Request

Path Parameters

mode(required): string

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

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object RndListDesignList

Title: RndListDesignList

Contains randomization list design details.

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

Nested Schema : RndListDesignList

Type: object

Title: RndListDesignList

Contains randomization list design details.

Show Source

randDesigns: array randDesigns
randListId: string (uuid)

Unique ID for randomization list.
randListName: string

Randomization list name

Example: UPL_RL191_V1001
randomizationSeed: number (double)

Seed number.

Example: 5
useSequenceNumber: boolean

Sequence number.

Example: false

{
    "title":"RndListDesignList",
    "type":"object",
    "properties":{
        "randListId":{
            "type":"string",
            "description":"Unique ID for randomization list.",
            "format":"uuid"
        },
        "randListName":{
            "type":"string",
            "description":"Randomization list name",
            "example":"UPL_RL191_V1001"
        },
        "randomizationSeed":{
            "type":"number",
            "description":"Seed number.",
            "format":"double",
            "example":"5"
        },
        "useSequenceNumber":{
            "type":"boolean",
            "description":"Sequence number.",
            "example":false
        },
        "randDesigns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RndListDesign"
            }
        }
    },
    "description":"Contains randomization list design details."
}

Nested Schema : randDesigns

Type: array

Show Source

Array of: object RndListDesign

Title: RndListDesign

Contains Randomization design detail.

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

Nested Schema : RndListDesign

Type: object

Title: RndListDesign

Contains Randomization design detail.

Show Source

randDesignName: string

Randomizatyion design name

Example: UPL_RL191_V1001
randDesignSrcId: string (uuid)

Unique Id for randomization design.
studyVersion: string

Version of the study

Example: 1.0.0.1

{
    "title":"RndListDesign",
    "type":"object",
    "properties":{
        "randDesignSrcId":{
            "type":"string",
            "description":"Unique Id for randomization design.",
            "format":"uuid"
        },
        "randDesignName":{
            "type":"string",
            "description":"Randomizatyion design name",
            "example":"UPL_RL191_V1001"
        },
        "studyVersion":{
            "type":"string",
            "description":"Version of the study",
            "example":"1.0.0.1"
        }
    },
    "description":"Contains Randomization design detail."
}

404 Response

For invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object