[Deprecated]: Get a randomization design
get
/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Deprecated: Use latest version instead. Retrieves a randomization design for a study version.
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 : RandomizationDto v1.0
Type:
object
Title:
RandomizationDto v1.0
Randomization Design Info
Show Source
-
arms: array
arms
-
details(required): object
RandomizationDetails v1.0
Title:
RandomizationDetails v1.0
Randomization Details DTO -
id: string
(uuid)
Randomization GUID
-
settings(required): object
RandomizationSettings v1.0
Title:
RandomizationSettings v1.0
Randomization Settings DTO -
studyId: string
(uuid)
Study ID
-
studyVersionStart: string
(date-time)
Study Version Start
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
-
visits: array
visits
Nested Schema : arms
Type:
Show Source
array
-
Array of:
object RandomizationArm v1.0
Title:
RandomizationArm v1.0
Randomization Treatment Arm Ratio
Nested Schema : RandomizationDetails v1.0
Type:
object
Title:
RandomizationDetails v1.0
Randomization Details DTO
Show Source
-
algorithm(required): string
Allowed Values:
[ "NONE", "CENTRAL", "CENTRAL_STRATIFIED", "SITE_BLOCKED_FIXED", "SITE_BLOCKED_FIXED_STRATIFIED", "SITE_BLOCKED_DYNAMIC", "SITE_BLOCKED_DYNAMIC_STRATIFIED", "COUNTRY_BLOCKED_FIXED", "COUNTRY_BLOCKED_FIXED_STRATIFIED", "COUNTRY_BLOCKED_DYNAMIC", "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED", "REGION_BLOCKED_FIXED", "REGION_BLOCKED_FIXED_STRATIFIED", "REGION_BLOCKED_DYNAMIC", "REGION_BLOCKED_DYNAMIC_STRATIFIED", "MINIMIZATION" ]
The algorithm of the randomization designExample:Central
-
cohortType(required): string
Allowed Values:
[ "NoCohort", "Adaptive", "Demography", "invalid" ]
The cohort type of the randomization designExample:None
-
description: string
Minimum Length:
0
Maximum Length:4000
Randomization Design DescriptionExample:Method to assign study participants to a treatment group.
-
title(required): string
Minimum Length:
1
Maximum Length:64
Randomization TitleExample:Rand 001
Nested Schema : RandomizationSettings v1.0
Type:
object
Title:
RandomizationSettings v1.0
Randomization Settings DTO
Show Source
-
assignSkippedRandomizationNumbers: boolean
Assign Skipped Randomization NumbersExample:
false
-
randomizeLimitsToCountEarlyTerminated(required): boolean
Randomize Limits to Count Early TerminatedExample:
false
-
randomizeNumberBlinded(required): boolean
Randomize Number BlindedExample:
false
-
randomizeSubjectsIfSitesOutOfKits(required): boolean
Restrict Randomization Numbers to Available Kit TypesExample:
false
Nested Schema : visits
Type:
Show Source
array
-
Array of:
object RandomizationVisit v1.0
Title:
RandomizationVisit v1.0
Randomization Visit
Nested Schema : RandomizationArm v1.0
Type:
object
Title:
RandomizationArm v1.0
Randomization Treatment Arm Ratio
Show Source
-
armVersionStart: string
(date-time)
Arm Version Start
-
id(required): string
(uuid)
Treatment Arm GUID
-
name: string
Treatment Arm NameExample:
Arm1
-
ratio(required): integer
(int32)
Minimum Value:
1
Treatment Arm ratiosExample:2
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
Nested Schema : RandomizationVisit v1.0
Type:
object
Title:
RandomizationVisit v1.0
Randomization Visit
Show Source
-
visitId(required): string
(uuid)
Visit GUID
-
visitName: string
Visit nameExample:
Week 3
500 Response
Error
Nested Schema : details
Type:
object