Get all active factors in a study
get
/ec-designer-svc/rest/v1.0/studies/{studyId}/randomizationfactors
Retrieves a list of Study factors. You can retrieve this list by study mode and RandType.
Request
Path Parameters
Query Parameters
-
mode(required): string
Study version mode to filter factors.Allowed Values:
[ "test", "training", "active" ]
-
type(required): string
Rand Algorithim to filter factors.Default Value:
ALL
Allowed Values:[ "stratum", "cohort", "minimization", "all" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Randomization Factor Details v1.0
Title:
Randomization Factor Details v1.0
Randomization Factors DTO
Nested Schema : Randomization Factor Details v1.0
Type:
object
Title:
Randomization Factor Details v1.0
Randomization Factors DTO
Show Source
-
details: object
RandomizationDetails v4.0
Title:
RandomizationDetails v4.0
Details of the randomization design. -
groups: object
RandomizationFactorGroupDto v1.0
Title:
RandomizationFactorGroupDto v1.0
RandomizationFactorGroupDto Info
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 : RandomizationFactorGroupDto v1.0
Type:
object
Title:
RandomizationFactorGroupDto v1.0
RandomizationFactorGroupDto Info
Show Source
-
formTitle: string
formTitleExample:
Demography
-
groupId: string
(uuid)
Rand Stratum Factor Id
-
groupName: string
Stratum or Cohort GroupNameExample:
Group Name 1
-
id: string
(uuid)
Stratum or Cohort Unique GUID
-
questionTitle: string
questionTitleExample:
Age
500 Response
Error
Nested Schema : details
Type:
object