Jump to

• Request
• Response

V2.0

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/randomizationfactors

Retrieves randomization factors for a study by study mode and factor type. Use mode to select the study version state and type to request strata, cohort, minimization, or all supported factor groups. The response returns the matching randomization factor groups and their form question details.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• mode(required): string
  Study mode used to filter factors. Allowed values: design (draft design data), test (testing data), training (training data), active (approved production data), all (all modes).

  Allowed Values: [ "test", "training", "active" ]

  Example:

  test

• type(required): string
  Rand Algorithim to filter factors.

  Default Value: ALL

  Allowed Values: [ "stratum", "cohort", "minimization", "all" ]

  Example:

  all

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Randomization Factor Details v2.0
  Title: Randomization Factor Details v2.0

  Randomization Factors DTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RandomizationFactorsV2"
    }
}

Nested Schema : Randomization Factor Details v2.0

Type: object

Title: Randomization Factor Details v2.0

Randomization Factors DTO

Show Source

• details: object RandomizationDetails v4.0
  Title: RandomizationDetails v4.0

  Details of the randomization design.
• groups: object RandomizationFactorGroupDto v2.0
  Title: RandomizationFactorGroupDto v2.0

  RandomizationFactorGroupDto Info

{
    "title":"Randomization Factor Details v2.0",
    "type":"object",
    "properties":{
        "details":{
            "$ref":"#/components/schemas/RandomizationDetailsV4"
        },
        "groups":{
            "title":"RandomizationFactorGroupDto v2.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Stratum or Cohort Unique GUID",
                    "format":"uuid"
                },
                "formTitle":{
                    "type":"string",
                    "description":"formTitle",
                    "example":"Demography"
                },
                "questionTitle":{
                    "type":"string",
                    "description":"questionTitle",
                    "example":"Age"
                },
                "groupName":{
                    "type":"string",
                    "description":"Stratum or Cohort GroupName",
                    "example":"Group Name 1"
                },
                "groupId":{
                    "type":"string",
                    "description":" Rand Stratum Factor Id",
                    "format":"uuid"
                },
                "formCategory":{
                    "type":"string",
                    "description":"Form category",
                    "example":"DCS"
                },
                "formSubcategory":{
                    "type":"string",
                    "description":"List of form subcategories"
                },
                "instructionalText":{
                    "type":"string",
                    "description":"Instructional Text"
                }
            },
            "description":"RandomizationFactorGroupDto Info"
        }
    },
    "description":"Randomization Factors DTO"
}

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 design

  Example: Central
• cohortType(required): string
  Allowed Values: [ "NoCohort", "Adaptive", "Demography", "invalid" ]

  The cohort type of the randomization design

  Example: None
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Randomization Design Description

  Example: Method to assign study participants to a treatment group.
• randomizationType(required): string
  Allowed Values: [ "Blinded", "Unblinded", "invalid" ]

  Type of the randomization design

  Example: Blinded
• reRandomization: boolean
  Whether to use re-randomization on the randomization design

  Example: true
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Randomization Title

  Example: Rand 001
• treatmentArms: string
  Allowed Values: [ "Randomized", "Mapped", "None", "invalid" ]

  Whether to use randomized or mapped on the randomization design

  Example: Randomized

{
    "title":"RandomizationDetails v4.0",
    "required":[
        "algorithm",
        "cohortType",
        "randomizationType",
        "title"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Randomization Title",
            "example":"Rand 001"
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Randomization Design Description",
            "example":"Method to assign study participants to a treatment group."
        },
        "algorithm":{
            "type":"string",
            "description":"The algorithm of the randomization design",
            "example":"Central",
            "enum":[
                "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"
            ]
        },
        "cohortType":{
            "type":"string",
            "description":"The cohort type of the randomization design",
            "example":"None",
            "enum":[
                "NoCohort",
                "Adaptive",
                "Demography",
                "invalid"
            ]
        },
        "randomizationType":{
            "type":"string",
            "description":"Type of the randomization design",
            "example":"Blinded",
            "enum":[
                "Blinded",
                "Unblinded",
                "invalid"
            ]
        },
        "reRandomization":{
            "type":"boolean",
            "description":"Whether to use re-randomization on the randomization design",
            "example":true
        },
        "treatmentArms":{
            "type":"string",
            "description":"Whether to use randomized or mapped on the randomization design",
            "example":"Randomized",
            "enum":[
                "Randomized",
                "Mapped",
                "None",
                "invalid"
            ]
        }
    },
    "description":"Details of the randomization design."
}

Nested Schema : RandomizationFactorGroupDto v2.0

Type: object

Title: RandomizationFactorGroupDto v2.0

RandomizationFactorGroupDto Info

Show Source

• formCategory: string
  Form category

  Example: DCS
• formSubcategory: string
  List of form subcategories
• formTitle: string
  formTitle

  Example: Demography
• groupId: string (uuid)
  Rand Stratum Factor Id
• groupName: string
  Stratum or Cohort GroupName

  Example: Group Name 1
• id: string (uuid)
  Stratum or Cohort Unique GUID
• instructionalText: string
  Instructional Text
• questionTitle: string
  questionTitle

  Example: Age

{
    "title":"RandomizationFactorGroupDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Stratum or Cohort Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"formTitle",
            "example":"Demography"
        },
        "questionTitle":{
            "type":"string",
            "description":"questionTitle",
            "example":"Age"
        },
        "groupName":{
            "type":"string",
            "description":"Stratum or Cohort GroupName",
            "example":"Group Name 1"
        },
        "groupId":{
            "type":"string",
            "description":" Rand Stratum Factor Id",
            "format":"uuid"
        },
        "formCategory":{
            "type":"string",
            "description":"Form category",
            "example":"DCS"
        },
        "formSubcategory":{
            "type":"string",
            "description":"List of form subcategories"
        },
        "instructionalText":{
            "type":"string",
            "description":"Instructional Text"
        }
    },
    "description":"RandomizationFactorGroupDto Info"
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

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-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top