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
Query Parameters
  • 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

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RatioArmDto v2.0
Type: object
Title: RatioArmDto v2.0
Treatment Arm ratio
Show Source

204 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RatioArmDto v2.0
Type: object
Title: RatioArmDto v2.0
Treatment Arm ratio
Show Source

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : details
Type: object
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
Back to Top