Create randomization design
post
/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations
Creates a new randomization design in a study version.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Supported Media Types
- */*
Root Schema : RandomizationDto v4.0
Type:
object
Title:
RandomizationDto v4.0
Randomization Design Info
Show Source
-
arms: array
arms
-
details(required): object
RandomizationDetails v4.0
Title:
RandomizationDetails v4.0
Details of the randomization design. -
id: string
(uuid)
Randomization GUID
-
settings(required): object
RandomizationSettings v4.0
Title:
RandomizationSettings v4.0
The settings for the randomization design. -
versionStart: string
(date-time)
Randomization VersionStartExample:
2021-01-17T15:41:10.733Z
-
visits: array
visits
Nested Schema : arms
Type:
Show Source
array
-
Array of:
object RandomizationArm v4.0
Title:
RandomizationArm v4.0
Randomization Design Treatment Arm Ratio
Nested Schema : RandomizationDetails v4.0
Type:
object
Title:
RandomizationDetails v4.0
Details of the randomization design.
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.
-
randomizationType(required): string
Allowed Values:
[ "Blinded", "Unblinded", "invalid" ]
Type of the randomization designExample:Blinded
-
reRandomization: boolean
Whether to use re-randomization on the randomization designExample:
true
-
title(required): string
Minimum Length:
1
Maximum Length:64
Randomization TitleExample:Rand 001
-
treatmentArms: string
Allowed Values:
[ "Randomized", "Mapped", "None", "invalid" ]
Whether to use randomized or mapped on the randomization designExample:Randomized
Nested Schema : RandomizationSettings v4.0
Type:
object
Title:
RandomizationSettings v4.0
The settings for the randomization design.
Show Source
-
assignNewRandomizeNumbers: boolean
Whether to assign new randomization numbers to all subjectsExample:
false
-
assignSkippedRandomizationNumbers: boolean
Whether to assign skipped randomization numbersExample:
false
-
randomizeLimitsToCountEarlyTerminated: boolean
Whether limits include withdrawn subjectsExample:
false
-
randomizeNumberBlinded: boolean
Whether to use blinded randomization numbersExample:
false
-
randomizeSubjectsIfSitesOutOfKits: boolean
Whether to restrict randomization numbers to available kit typesExample:
false
Nested Schema : visits
Type:
Show Source
array
-
Array of:
object RandomizationVisit v4.0
Title:
RandomizationVisit v4.0
Randomization Visit
Nested Schema : RandomizationArm v4.0
Type:
object
Title:
RandomizationArm v4.0
Randomization Design Treatment Arm Ratio
Show Source
-
id(required): string
(uuid)
Treatment Arm GUID
-
name: string
Treatment Arm NameExample:
Arm1
-
ratio(required): integer
(int32)
Minimum Value:
1
Maximum Value:99
Allowed Values:[ null ]
The ratio defined for the treatment armExample:2
Nested Schema : RandomizationVisit v4.0
Type:
object
Title:
RandomizationVisit v4.0
Randomization Visit
Show Source
-
branchId: string
(uuid)
The id of the branch
-
visitId(required): string
(uuid)
Visit GUID
-
visitName: string
Visit nameExample:
Week 3
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : RandomizationDto v4.0
Type:
object
Title:
RandomizationDto v4.0
Randomization Design Info
Show Source
-
arms: array
arms
-
details(required): object
RandomizationDetails v4.0
Title:
RandomizationDetails v4.0
Details of the randomization design. -
id: string
(uuid)
Randomization GUID
-
settings(required): object
RandomizationSettings v4.0
Title:
RandomizationSettings v4.0
The settings for the randomization design. -
versionStart: string
(date-time)
Randomization VersionStartExample:
2021-01-17T15:41:10.733Z
-
visits: array
visits
Nested Schema : arms
Type:
Show Source
array
-
Array of:
object RandomizationArm v4.0
Title:
RandomizationArm v4.0
Randomization Design Treatment Arm Ratio
Nested Schema : RandomizationDetails v4.0
Type:
object
Title:
RandomizationDetails v4.0
Details of the randomization design.
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.
-
randomizationType(required): string
Allowed Values:
[ "Blinded", "Unblinded", "invalid" ]
Type of the randomization designExample:Blinded
-
reRandomization: boolean
Whether to use re-randomization on the randomization designExample:
true
-
title(required): string
Minimum Length:
1
Maximum Length:64
Randomization TitleExample:Rand 001
-
treatmentArms: string
Allowed Values:
[ "Randomized", "Mapped", "None", "invalid" ]
Whether to use randomized or mapped on the randomization designExample:Randomized
Nested Schema : RandomizationSettings v4.0
Type:
object
Title:
RandomizationSettings v4.0
The settings for the randomization design.
Show Source
-
assignNewRandomizeNumbers: boolean
Whether to assign new randomization numbers to all subjectsExample:
false
-
assignSkippedRandomizationNumbers: boolean
Whether to assign skipped randomization numbersExample:
false
-
randomizeLimitsToCountEarlyTerminated: boolean
Whether limits include withdrawn subjectsExample:
false
-
randomizeNumberBlinded: boolean
Whether to use blinded randomization numbersExample:
false
-
randomizeSubjectsIfSitesOutOfKits: boolean
Whether to restrict randomization numbers to available kit typesExample:
false
Nested Schema : visits
Type:
Show Source
array
-
Array of:
object RandomizationVisit v4.0
Title:
RandomizationVisit v4.0
Randomization Visit
Nested Schema : RandomizationArm v4.0
Type:
object
Title:
RandomizationArm v4.0
Randomization Design Treatment Arm Ratio
Show Source
-
id(required): string
(uuid)
Treatment Arm GUID
-
name: string
Treatment Arm NameExample:
Arm1
-
ratio(required): integer
(int32)
Minimum Value:
1
Maximum Value:99
Allowed Values:[ null ]
The ratio defined for the treatment armExample:2
Nested Schema : RandomizationVisit v4.0
Type:
object
Title:
RandomizationVisit v4.0
Randomization Visit
Show Source
-
branchId: string
(uuid)
The id of the branch
-
visitId(required): string
(uuid)
Visit GUID
-
visitName: string
Visit nameExample:
Week 3
500 Response
Error
Nested Schema : details
Type:
object