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.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object RatioArmDto v2.0
Title:
RatioArmDto v2.0Treatment Arm ratio
Nested Schema : RatioArmDto v2.0
Type:
objectTitle:
RatioArmDto v2.0Treatment Arm ratio
Show Source
-
description: string
Treatment Arm DescriptionExample:
Monad NP (60ml) Syrup -
id: string
(uuid)
Treatment Arm GUID
-
name: string
Treatment Arm NameExample:
Drug Arm 1
204 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object RatioArmDto v2.0
Title:
RatioArmDto v2.0Treatment Arm ratio
Nested Schema : RatioArmDto v2.0
Type:
objectTitle:
RatioArmDto v2.0Treatment Arm ratio
Show Source
-
description: string
Treatment Arm DescriptionExample:
Monad NP (60ml) Syrup -
id: string
(uuid)
Treatment Arm GUID
-
name: string
Treatment Arm NameExample:
Drug Arm 1
500 Response
Error
Root Schema : ErrorResponseData
Type:
objectStructure 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