1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Study APIs
  5. Study Randomization Factors
  6. Get all active factors in a study

V3.0

get

/ec-designer-ors-svc/rest/v3.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
Query Parameters
  • Minimum Length: 4
    Maximum Length: 8
    Required. Study version mode filter. Allowed values: test = testing study versions, training = training study versions, active = active study versions.
    Allowed Values: [ "test", "training", "active" ]
    Example:
    active
  • Minimum Length: 3
    Maximum Length: 12
    Required. Randomization factor type filter. Allowed values: stratum = strata factors, cohort = cohort factors, minimization = minimization factors, all = every supported factor type.
    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

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RandomizationFactorsItemV3
Type: object
Randomization factor details returned by the v3 get randomization factors endpoint.
Show Source
Nested Schema : RandomizationDetailsV3Doc
Type: object
Randomization design details returned with v3 randomization factors.
Show Source
  • Minimum Length: 4
    Maximum Length: 31
    Allowed Values: [ "None", "Central", "CentralStratified", "SiteBlockedFixed", "SiteBlockedFixedStratified", "SiteBlockedDynamic", "SiteBlockedDynamicStratified", "CountryBlockedFixed", "CountryBlockedFixedStratified", "CountryBlockedDynamic", "CountryBlockedDynamicStratified", "RegionBlockedFixed", "RegionBlockedFixedStratified", "RegionBlockedDynamic", "RegionBlockedDynamicStratified", "Minimization" ]
    Randomization algorithm. Allowed values: None = no randomization algorithm configured, Central = centrally managed randomization without stratification, CentralStratified = central stratified randomization, SiteBlockedFixed = site-blocked fixed randomization, SiteBlockedFixedStratified = site-blocked fixed stratified randomization, SiteBlockedDynamic = site-blocked dynamic randomization, SiteBlockedDynamicStratified = site-blocked dynamic stratified randomization, CountryBlockedFixed = country-blocked fixed randomization, CountryBlockedFixedStratified = country-blocked fixed stratified randomization, CountryBlockedDynamic = country-blocked dynamic randomization, CountryBlockedDynamicStratified = country-blocked dynamic stratified randomization, RegionBlockedFixed = region-blocked fixed randomization, RegionBlockedFixedStratified = region-blocked fixed stratified randomization, RegionBlockedDynamic = region-blocked dynamic randomization, RegionBlockedDynamicStratified = region-blocked dynamic stratified randomization, Minimization = minimization algorithm.
    Example: Central
  • Minimum Length: 7
    Maximum Length: 10
    Allowed Values: [ "NoCohort", "Adaptive", "Demography", "invalid" ]
    Cohort behavior for the randomization design. Allowed values: NoCohort = no cohorting is applied, Adaptive = adaptive cohorts are used, Demography = demographic cohorts are used, invalid = unrecognized persisted value.
    Example: NoCohort
  • Minimum Length: 1
    Maximum Length: 4000
    Randomization design description.
    Example: Method to assign study participants to a treatment group.
  • Minimum Length: 7
    Maximum Length: 10
    Allowed Values: [ "Blinded", "Unblinded", "invalid" ]
    Randomization blinding type. Allowed values: Blinded = subject assignments remain blinded, Unblinded = subject assignments are visible, invalid = unrecognized persisted value.
    Example: Blinded
  • Indicates whether re-randomization is enabled.
    Example: true
  • Minimum Length: 1
    Maximum Length: 64
    Randomization design title.
    Example: Rand 001
  • Minimum Length: 4
    Maximum Length: 10
    Allowed Values: [ "Randomized", "Mapped", "None", "invalid" ]
    Treatment arm assignment mode. Allowed values: Randomized = arms are assigned by the randomization algorithm, Mapped = arms are mapped explicitly, None = no treatment arms are configured, invalid = unrecognized persisted value.
    Example: Randomized
Nested Schema : groups
Type: array
Minimum Number of Items: 0
Form item groups returned for the selected randomization factor type.
Show Source
Example:
[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "formTitle":"Demography",
        "questionTitle":"Age",
        "groupName":"Group Name 1",
        "groupId":"A1B8327AFAA6412287106192AB5984EF",
        "formCategory":"DCS",
        "formSubcategory":"Baseline",
        "instructionalText":"Select participant age range",
        "parentCohortId":"C1B8327AFAA6412287106192AB5984EF",
        "parentCohortName":"Adult Cohort"
    }
]
Nested Schema : RandomizationFactorGroupV3Doc
Type: object
Form item group details returned for a randomization factor.
Show Source
  • Minimum Length: 3
    Maximum Length: 3
    Form category for the factor.
    Example: DCS
  • Minimum Length: 1
    Maximum Length: 255
    Form subcategory for the factor when present.
    Example: Baseline
  • Minimum Length: 1
    Maximum Length: 64
    Form title containing the factor.
    Example: Demography
  • Minimum Length: 32
    Maximum Length: 32
    Stratum or cohort group unique identifier.
  • Minimum Length: 1
    Maximum Length: 64
    Stratum or cohort group name.
    Example: Group Name 1
  • Minimum Length: 32
    Maximum Length: 32
    Question or factor unique identifier.
  • Minimum Length: 1
    Maximum Length: 4000
    Instructional text configured for the factor question.
    Example: Select participant age range
  • Minimum Length: 32
    Maximum Length: 32
    Parent cohort unique identifier when the factor belongs to a cohort.
  • Minimum Length: 1
    Maximum Length: 64
    Parent cohort name when the factor belongs to a cohort.
    Example: Adult Cohort
  • Minimum Length: 1
    Maximum Length: 64
    Question title displayed to study designers.
    Example: Age
Examples

500 Response

Returned when the service cannot load randomization factors for the supplied study, mode, and factor type because of an unexpected server-side failure.
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

Back to Top