Jump to

• Request
• Response

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"

Query Parameters

• visitDesignPathIds: string
  Comma-separated list of Visit Design Path IDs (UUIDs) to scope the randomization retrieval and this parameter is applicable for algorithm type None only

  Example:

  3BCE1EE7AD7B4625B76876A49A7144CF,4BCE1EE7AD7B4625B76876A49A7144CE,7BCE1EE7AD7B4625B76876A49A7144CD

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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.

Body ()

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

Body ()

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

Back to Top