Create randomization list
post
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
Generates a randomization list in the study; Rights: DesignerRandListPost.
Request
Path Parameters
-
studyVersion(required): string
Version of the study
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Request Object to create randomization list
Show Source
-
blocksPerCohort: integer
(int32)
Minimum Value:
1
Maximum Value:500000
Number of blocks per cohort.Example:5
-
blocksPerStratum: integer
(int32)
Minimum Value:
1
Maximum Value:500000
Number of blocks per stratum.Example:5
-
blocksPerStratumPerCohort: integer
(int32)
Minimum Value:
1
Maximum Value:500000
Number of blocks per stratum per cohort.Example:5
-
description: string
Minimum Length:
0
Maximum Length:2000
Description of randomization listExample:Randomization list with demographic cohort
-
initialRandNumber(required): integer
(int64)
Minimum Value:
1
Maximum Value:99999999
Starting number.Example:1
-
mode: string
Mode of the study, accepts: test, active, or trainingExample:
test, active, or training
-
noOfRows: integer
(int32)
Minimum Value:
1
Maximum Value:500000
Number of blocks.Example:5
-
randomizationSeed: integer
(int32)
Minimum Value:
1
Maximum Value:99999999
-
srcId(required): string
(uuid)
Unique Id.
-
srcVersionStart(required): string
(date-time)
Version Start
-
title(required): string
Minimum Length:
1
Maximum Length:64
Title of randomization listExample:UPL_RL191_V1001
-
treatmentRatioMultiplier(required): integer
(int32)
Minimum Value:
1
Maximum Value:99
Multiplier for blocks.Example:5
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : GenerateResponse
Type:
object
Response Object for created randomization list.
Show Source
-
listId: string
Unique Id of generated randomization listExample:
9ECA4FA65076451DA7D47D59367D15A5
-
noOfRowsGenerated: integer
(int32)
Number of rows generated for randomization list.Example:
5
400 Response
For algorithm not defined for the randomization design or randomization design not associated with a visit
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
404 Response
For Invalid study ID or version
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