REST API for Clinical One Platform

Associate randomization design to randomization list

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}

Associates a randomization design to a randomization list. Rights: OrsRandListPost, OrsUnblinded.

Request

Path Parameters

listId(required): string(uuid)

ID of the randomization list
mode(required): string

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

ID of the study
studyVersion(required): string

Version of the study

Supported Media Types

Root Schema : schema

Type: object

Request Object for randomization design list

Show Source

randDesignSrcIds(required): array randDesignSrcIds

{
    "required":[
        "randDesignSrcIds"
    ],
    "type":"object",
    "properties":{
        "randDesignSrcIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Request Object for randomization design list"
}

Nested Schema : randDesignSrcIds

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: string

404 Response

For randomization design not found or randomization list can't be generated as there is no algorithm for the randomization designOr you must associate the randomization design with a visit before you can create a randomization listOr the combination of study version and randomization design is already associated with another randomization listOr treatment arms in the study version aren't the same as the treatment arms in the randomization listOr the type of randomization used to create the list doesn't match the type in the randomization designOr the stratum groups in the study version aren't the same as the stratum groups in the randomization listOr you can''t use this randomization list. Cohort groups in the study version aren't the same as the cohort groups in the randomization list

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