Create list of cohort groups
post
/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Creates a list of new cohort groups 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"
Supported Media Types
- */*
Root Schema : schema
Type:
Show Source
array
-
Array of:
object StratumDto v2.0
Title:
StratumDto v2.0
Randomization Stratum Detail Information
Nested Schema : StratumDto v2.0
Type:
object
Title:
StratumDto v2.0
Randomization Stratum Detail Information
Show Source
-
factors: array
factors
-
id: string
(uuid)
Stratum Unique GUID
-
name(required): string
Minimum Length:
1
Maximum Length:64
Stratum NameExample:Stratum Group 1
-
objectId: string
Value of Object GUIDExample:
B1B8327AFAA6412287106192AB5984EF
-
objectType: string
Type of ObjectExample:
Code List
-
randomizationType: string
Type of StratumExample:
Stratified
-
weight: string
Weight of Stratum GroupExample:
1
Nested Schema : factors
Type:
Show Source
array
-
Array of:
object StratumFactorDto v3.0
Title:
StratumFactorDto v3.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }
Randomization Stratum Factor Information
Nested Schema : StratumFactorDto v3.0
Type:
object
Title:
StratumFactorDto v3.0
Discriminator: type
Discriminator Values
Randomization Stratum Factor Information
Show Source
-
formId(required): string
(uuid)
Form GUID
-
groupId: string
(uuid)
Stratum Group Id
-
groupName: string
Stratum NameExample:
Stratum Group 1
-
itemId(required): string
(uuid)
Form item GUID
-
type(required): string
Match One Schema
Show Source
-
object
StratumChoiceFactorDto v3.0
Title:
StratumChoiceFactorDto v3.0
Stratum Choice Factor Detail Information -
object
StratumRangeFactorDto v3.0
Title:
StratumRangeFactorDto v3.0
Stratum Range Factor Detail Information
Nested Schema : StratumChoiceFactorDto v3.0
Type:
object
Title:
StratumChoiceFactorDto v3.0
Stratum Choice Factor Detail Information
Match All
Stratum Choice Factor Detail Information
Stratum Choice Factor Detail Information
Show Source
-
object
StratumFactorDto v3.0
Title:
StratumFactorDto v3.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }
Randomization Stratum Factor Information -
object
StratumChoiceFactorDto v3.0-allOf[1]
Nested Schema : StratumRangeFactorDto v3.0
Type:
object
Title:
StratumRangeFactorDto v3.0
Stratum Range Factor Detail Information
Match All
Stratum Range Factor Detail Information
Stratum Range Factor Detail Information
Show Source
-
object
StratumFactorDto v3.0
Title:
StratumFactorDto v3.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }
Randomization Stratum Factor Information -
object
StratumRangeFactorDto v3.0-allOf[1]
Nested Schema : StratumChoiceFactorDto v3.0-allOf[1]
Type:
Show Source
object
-
codelistitemIds: array
codelistitemIds
Minimum Number of Items:
1
Maximum Number of Items:2147483647
-
values: array
values
Minimum Number of Items:
1
Maximum Number of Items:2147483647
Nested Schema : codelistitemIds
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2147483647
-
Array of:
string(uuid)
Selected from choice factor's code list choice codelistItem Ids
Nested Schema : values
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2147483647
-
Array of:
string
Minimum Length:
1
Maximum Length:2147483647
Selected from choice factor's code list choice valuesExample:1
Nested Schema : StratumRangeFactorDto v3.0-allOf[1]
Type:
Show Source
object
-
max: number
(double)
Stratum Factor Max valueExample:
120
-
min: number
(double)
Stratum Factor Min valueExample:
20
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object StratumDto v2.0
Title:
StratumDto v2.0
Randomization Stratum Detail Information
Nested Schema : StratumDto v2.0
Type:
object
Title:
StratumDto v2.0
Randomization Stratum Detail Information
Show Source
-
factors: array
factors
-
id: string
(uuid)
Stratum Unique GUID
-
name(required): string
Minimum Length:
1
Maximum Length:64
Stratum NameExample:Stratum Group 1
-
objectId: string
Value of Object GUIDExample:
B1B8327AFAA6412287106192AB5984EF
-
objectType: string
Type of ObjectExample:
Code List
-
randomizationType: string
Type of StratumExample:
Stratified
-
weight: string
Weight of Stratum GroupExample:
1
Nested Schema : factors
Type:
Show Source
array
-
Array of:
object StratumFactorDto v3.0
Title:
StratumFactorDto v3.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }
Randomization Stratum Factor Information
Nested Schema : StratumFactorDto v3.0
Type:
object
Title:
StratumFactorDto v3.0
Discriminator: type
Discriminator Values
Randomization Stratum Factor Information
Show Source
-
formId(required): string
(uuid)
Form GUID
-
groupId: string
(uuid)
Stratum Group Id
-
groupName: string
Stratum NameExample:
Stratum Group 1
-
itemId(required): string
(uuid)
Form item GUID
-
type(required): string
Match One Schema
Show Source
-
object
StratumChoiceFactorDto v3.0
Title:
StratumChoiceFactorDto v3.0
Stratum Choice Factor Detail Information -
object
StratumRangeFactorDto v3.0
Title:
StratumRangeFactorDto v3.0
Stratum Range Factor Detail Information
Nested Schema : StratumChoiceFactorDto v3.0
Type:
object
Title:
StratumChoiceFactorDto v3.0
Stratum Choice Factor Detail Information
Match All
Stratum Choice Factor Detail Information
Stratum Choice Factor Detail Information
Show Source
-
object
StratumFactorDto v3.0
Title:
StratumFactorDto v3.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }
Randomization Stratum Factor Information -
object
StratumChoiceFactorDto v3.0-allOf[1]
Nested Schema : StratumRangeFactorDto v3.0
Type:
object
Title:
StratumRangeFactorDto v3.0
Stratum Range Factor Detail Information
Match All
Stratum Range Factor Detail Information
Stratum Range Factor Detail Information
Show Source
-
object
StratumFactorDto v3.0
Title:
StratumFactorDto v3.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }
Randomization Stratum Factor Information -
object
StratumRangeFactorDto v3.0-allOf[1]
Nested Schema : StratumChoiceFactorDto v3.0-allOf[1]
Type:
Show Source
object
-
codelistitemIds: array
codelistitemIds
Minimum Number of Items:
1
Maximum Number of Items:2147483647
-
values: array
values
Minimum Number of Items:
1
Maximum Number of Items:2147483647
Nested Schema : codelistitemIds
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2147483647
-
Array of:
string(uuid)
Selected from choice factor's code list choice codelistItem Ids
Nested Schema : values
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2147483647
-
Array of:
string
Minimum Length:
1
Maximum Length:2147483647
Selected from choice factor's code list choice valuesExample:1
Nested Schema : StratumRangeFactorDto v3.0-allOf[1]
Type:
Show Source
object
-
max: number
(double)
Stratum Factor Max valueExample:
120
-
min: number
(double)
Stratum Factor Min valueExample:
20
500 Response
Error
Root Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.