1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Randomization APIs
  5. Study Strata
  6. Get a stratum group

V4.0

get

/ec-designer-ors-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}

Retrieves one stratum group for the specified randomization design in a study version. The stratumId path parameter identifies the stratum, and the response returns its factors, selected form items or choices, and related grouping details.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : StrataItemV4
Type: object
Stratum details returned by the v4 strata read APIs.
Show Source
  • factors
    Stratification factors used to define the stratum.
  • Minimum Length: 32
    Maximum Length: 32
    Stratum unique identifier.
  • Minimum Length: 1
    Maximum Length: 64
    Stratum display name.
    Example: Minimization Group 1
  • Minimum Length: 32
    Maximum Length: 32
    Object unique identifier associated with the objectType.
  • Minimum Length: 8
    Maximum Length: 12
    Allowed Values: [ "FORMITEM", "CLCODEVALUES" ]
    Object type for minimization strata. Allowed values: FORMITEM = minimization factor sourced from a form item, CLCODEVALUES = minimization factor sourced from configured code list values. This field can be null for non-minimization strata.
    Example: CLCODEVALUES
  • Minimum Length: 32
    Maximum Length: 32
    Parent cohort unique identifier when the stratum belongs to a cohort.
  • Minimum Length: 1
    Maximum Length: 64
    Parent cohort name when the stratum belongs to a cohort.
    Example: Adult Cohort
  • Minimum Length: 7
    Maximum Length: 14
    Allowed Values: [ "STRATUM", "ADAPTIVESTRATUM", "MINIMIZATION" ]
    Randomization type for the returned stratum. Allowed values: STRATUM = standard stratified randomization stratum, ADAPTIVESTRATUM = adaptive stratified randomization stratum, MINIMIZATION = minimization randomization stratum.
    Example: MINIMIZATION
  • Minimum Value: 0
    Weight assigned to the stratum when weighted selection is used.
    Example: 1
Nested Schema : factors
Type: array
Stratification factors used to define the stratum.
Show Source
Example:
[
    {
        "type":"choice",
        "formId":"D1B8327AFAA6412287106192AB5984EF",
        "itemId":"E1B8327AFAA6412287106192AB5984EF",
        "groupName":"Age Group",
        "groupId":"F1B8327AFAA6412287106192AB5984EF",
        "values":[
            "18-40",
            "41-65"
        ],
        "codelistitemIds":[
            "977443BF3EFB43888026788E7F7CCE96",
            "877443BF3EFB43888026788E7F7CCE95"
        ]
    }
]
Nested Schema : StrataFactorV4
Type: object
Factor details returned for a v4 stratum.
Show Source
  • codelistitemIds
    Identifiers of the selected code list items for a choice factor.
  • Minimum Length: 32
    Maximum Length: 32
    Form unique identifier that owns the factor item.
  • Minimum Length: 32
    Maximum Length: 32
    Factor group unique identifier.
  • Minimum Length: 1
    Maximum Length: 64
    Factor group display name.
    Example: Age Group
  • Minimum Length: 32
    Maximum Length: 32
    Form item unique identifier for the factor item.
  • Maximum numeric value for a range factor. Negative values are allowed when supported by the linked numeric form item's validation range.
    Example: 30
  • Minimum numeric value for a range factor. Negative values are allowed when supported by the linked numeric form item's validation range.
    Example: -5
  • Minimum Length: 5
    Maximum Length: 6
    Allowed Values: [ "choice", "range" ]
    Factor type. Allowed values: choice = factor based on one or more coded choice values, range = factor based on a numeric range.
    Example: choice
  • values
    Selected code list values for a choice factor.
Nested Schema : codelistitemIds
Type: array
Identifiers of the selected code list items for a choice factor.
Show Source
Example:
[
    "977443BF3EFB43888026788E7F7CCE96",
    "877443BF3EFB43888026788E7F7CCE95"
]
Nested Schema : values
Type: array
Selected code list values for a choice factor.
Show Source
Example:
[
    "18-40",
    "41-65"
]
Examples

500 Response

Returned when the service cannot load the requested stratum for the supplied study version and randomization 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