Get list of all treatment arms for a randomization
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/treatments
Retrieves a list of all treatment arms for a randomization design. Rights: DesignerRandListGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
rndDesignId(required): string(uuid)
ID of the randomization design
-
studyId(required): string(uuid)
ID of the study
-
studyVersion(required): string
Version of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- */*
200 Response
Successful operation
Nested Schema : Treatment
Type:
object
Contains treatment details.
Show Source
-
comment: string
CommentExample:
Some comment
-
description: string
Treatment descriptionExample:
Treatment description
-
externalTreatmentId: string
External treatment identifier.Example:
Treatment A
-
id: string
(uuid)
ID of the treatment
-
objectVersionNumber: number
(double)
Object version numberExample:
5
-
operationType: string
Allowed Values:
[ "CREATED", "MODIFIED" ]
Operation typeExample:MODIFIED
-
reason: string
ReasonExample:
Some reason
-
shortName: string
Treatment short nameExample:
TxA
-
softwareVersionNumber: number
(double)
Software version numberExample:
5
-
srcId: string
(uuid)
Internal ID of treatment
-
srcVersionStart: string
(date-time)
Internal version start of treatment
-
studyId: string
(uuid)
ID of the study
-
studyVersionStart: string
(date-time)
Version of the study
-
treatmentId: string
(uuid)
-
userId: string
(uuid)
User Id
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
404 Response
Study not found. Or randomization design not found
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
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 requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object