REST API for Clinical One Platform

Get list of treatment arms

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/arms

Retrieves list of treatment arms associated with a randomization design.

Request

Path Parameters

randomId(required): string(uuid)

Randomization ID.
studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E
version(required): string

Study version. Example: "1.0.0.1"

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 RatioArmDto v2.0

Title: RatioArmDto v2.0

Treatment Arm ratio

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

Nested Schema : RatioArmDto v2.0

Type: object

Title: RatioArmDto v2.0

Treatment Arm ratio

Show Source

description: string

Treatment Arm Description

Example: Monad NP (60ml) Syrup
id: string (uuid)

Treatment Arm GUID
name: string

Treatment Arm Name

Example: Drug Arm 1

{
    "title":"RatioArmDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Treatment Arm Name",
            "example":"Drug Arm 1"
        },
        "description":{
            "type":"string",
            "description":"Treatment Arm Description",
            "example":"Monad NP (60ml) Syrup"
        }
    },
    "description":"Treatment Arm ratio"
}

204 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object RatioArmDto v2.0

Title: RatioArmDto v2.0

Treatment Arm ratio

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

Nested Schema : RatioArmDto v2.0

Type: object

Title: RatioArmDto v2.0

Treatment Arm ratio

Show Source

description: string

Treatment Arm Description

Example: Monad NP (60ml) Syrup
id: string (uuid)

Treatment Arm GUID
name: string

Treatment Arm Name

Example: Drug Arm 1

{
    "title":"RatioArmDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Treatment Arm Name",
            "example":"Drug Arm 1"
        },
        "description":{
            "type":"string",
            "description":"Treatment Arm Description",
            "example":"Monad NP (60ml) Syrup"
        }
    },
    "description":"Treatment Arm ratio"
}

500 Response

Error

Root 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 : details

Type: object