REST API for Clinical One Cloud Service

V3.0

get

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

Retrieves a list of Study factors. You can retrieve this list by study mode and RandType.

Request

Path Parameters

studyId(required): string(uuid)

Study unique identifier.

Query Parameters

mode(required): string
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
```
type(required): string
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.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object RandomizationFactorsItemV3

Randomization factor details returned by the v3 get randomization factors endpoint.

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

Nested Schema : RandomizationFactorsItemV3

Type: object

Randomization factor details returned by the v3 get randomization factors endpoint.

Show Source

details: object RandomizationDetailsV3Doc

Randomization design details returned with v3 randomization factors.
groups: array groups

Minimum Number of Items: 0

Form item groups returned for the selected randomization factor type.

{
    "type":"object",
    "properties":{
        "details":{
            "$ref":"#/components/schemas/RandomizationDetailsV3Doc"
        },
        "groups":{
            "minItems":0,
            "type":"array",
            "description":"Form item groups returned for the selected randomization factor type.",
            "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"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/RandomizationFactorGroupV3Doc"
            }
        }
    },
    "description":"Randomization factor details returned by the v3 get randomization factors endpoint."
}

Nested Schema : RandomizationDetailsV3Doc

Type: object

Randomization design details returned with v3 randomization factors.

Show Source

algorithm: string

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
cohortType: string

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
description: string

Minimum Length: 1

Maximum Length: 4000

Randomization design description.

Example: Method to assign study participants to a treatment group.
randomizationType: string

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
reRandomization: boolean

Indicates whether re-randomization is enabled.

Example: true
title: string

Minimum Length: 1

Maximum Length: 64

Randomization design title.

Example: Rand 001
treatmentArms: string

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

{
    "type":"object",
    "properties":{
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Randomization design title.",
            "example":"Rand 001"
        },
        "description":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Randomization design description.",
            "example":"Method to assign study participants to a treatment group."
        },
        "algorithm":{
            "maxLength":31,
            "minLength":4,
            "type":"string",
            "description":"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",
            "enum":[
                "None",
                "Central",
                "CentralStratified",
                "SiteBlockedFixed",
                "SiteBlockedFixedStratified",
                "SiteBlockedDynamic",
                "SiteBlockedDynamicStratified",
                "CountryBlockedFixed",
                "CountryBlockedFixedStratified",
                "CountryBlockedDynamic",
                "CountryBlockedDynamicStratified",
                "RegionBlockedFixed",
                "RegionBlockedFixedStratified",
                "RegionBlockedDynamic",
                "RegionBlockedDynamicStratified",
                "Minimization"
            ]
        },
        "cohortType":{
            "maxLength":10,
            "minLength":7,
            "type":"string",
            "description":"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",
            "enum":[
                "NoCohort",
                "Adaptive",
                "Demography",
                "invalid"
            ]
        },
        "randomizationType":{
            "maxLength":10,
            "minLength":7,
            "type":"string",
            "description":"Randomization blinding type. Allowed values: Blinded = subject assignments remain blinded, Unblinded = subject assignments are visible, invalid = unrecognized persisted value.",
            "example":"Blinded",
            "enum":[
                "Blinded",
                "Unblinded",
                "invalid"
            ]
        },
        "reRandomization":{
            "type":"boolean",
            "description":"Indicates whether re-randomization is enabled.",
            "example":true
        },
        "treatmentArms":{
            "maxLength":10,
            "minLength":4,
            "type":"string",
            "description":"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",
            "enum":[
                "Randomized",
                "Mapped",
                "None",
                "invalid"
            ]
        }
    },
    "description":"Randomization design details returned with v3 randomization factors."
}

Nested Schema : groups

Type: array

Minimum Number of Items: 0

Form item groups returned for the selected randomization factor type.

Show Source

Array of: object RandomizationFactorGroupV3Doc

Form item group details returned for a randomization factor.

{
    "minItems":0,
    "type":"array",
    "description":"Form item groups returned for the selected randomization factor type.",
    "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"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/RandomizationFactorGroupV3Doc"
    }
}

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

formCategory: string

Minimum Length: 3

Maximum Length: 3

Form category for the factor.

Example: DCS
formSubcategory: string

Minimum Length: 1

Maximum Length: 255

Form subcategory for the factor when present.

Example: Baseline
formTitle: string

Minimum Length: 1

Maximum Length: 64

Form title containing the factor.

Example: Demography
groupId: string (uuid)

Minimum Length: 32

Maximum Length: 32

Stratum or cohort group unique identifier.
groupName: string

Minimum Length: 1

Maximum Length: 64

Stratum or cohort group name.

Example: Group Name 1
id: string (uuid)

Minimum Length: 32

Maximum Length: 32

Question or factor unique identifier.
instructionalText: string

Minimum Length: 1

Maximum Length: 4000

Instructional text configured for the factor question.

Example: Select participant age range
parentCohortId: string (uuid)

Minimum Length: 32

Maximum Length: 32

Parent cohort unique identifier when the factor belongs to a cohort.
parentCohortName: string

Minimum Length: 1

Maximum Length: 64

Parent cohort name when the factor belongs to a cohort.

Example: Adult Cohort
questionTitle: string

Minimum Length: 1

Maximum Length: 64

Question title displayed to study designers.

Example: Age

{
    "type":"object",
    "properties":{
        "id":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Question or factor unique identifier.",
            "format":"uuid"
        },
        "formTitle":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form title containing the factor.",
            "example":"Demography"
        },
        "questionTitle":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Question title displayed to study designers.",
            "example":"Age"
        },
        "groupName":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Stratum or cohort group name.",
            "example":"Group Name 1"
        },
        "groupId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Stratum or cohort group unique identifier.",
            "format":"uuid"
        },
        "formCategory":{
            "maxLength":3,
            "minLength":3,
            "type":"string",
            "description":"Form category for the factor.",
            "example":"DCS"
        },
        "formSubcategory":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Form subcategory for the factor when present.",
            "example":"Baseline"
        },
        "instructionalText":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Instructional text configured for the factor question.",
            "example":"Select participant age range"
        },
        "parentCohortId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Parent cohort unique identifier when the factor belongs to a cohort.",
            "format":"uuid"
        },
        "parentCohortName":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Parent cohort name when the factor belongs to a cohort.",
            "example":"Adult Cohort"
        }
    },
    "description":"Form item group details returned for a randomization factor."
}

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.

Root Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Examples