REST API for Clinical One Cloud Service

V4.0

get

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

Retrieves a list of all strata groups associated with a randomization design.

Request

Path Parameters

randomId(required): string(uuid)

Randomization ID
studyId(required): string(uuid)

Study unique identifier.
version(required): string

Study version identifier.

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 StrataItemV4

Stratum details returned by the v4 strata read APIs.

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

Nested Schema : StrataItemV4

Type: object

Stratum details returned by the v4 strata read APIs.

Show Source

factors: array factors

Stratification factors used to define the stratum.
id: string (uuid)

Minimum Length: 32

Maximum Length: 32

Stratum unique identifier.
name: string

Minimum Length: 1

Maximum Length: 64

Stratum display name.

Example: Minimization Group 1
objectId: string (uuid)

Minimum Length: 32

Maximum Length: 32

Object unique identifier associated with the objectType.
objectType: string

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
parentCohortId: string (uuid)

Minimum Length: 32

Maximum Length: 32

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

Minimum Length: 1

Maximum Length: 64

Parent cohort name when the stratum belongs to a cohort.

Example: Adult Cohort
randomizationType: string

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
weight: integer (int32)

Minimum Value: 0

Weight assigned to the stratum when weighted selection is used.

Example: 1

{
    "type":"object",
    "properties":{
        "id":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Stratum unique identifier.",
            "format":"uuid"
        },
        "name":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Stratum display name.",
            "example":"Minimization Group 1"
        },
        "parentCohortId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Parent cohort unique identifier when the stratum belongs to a cohort.",
            "format":"uuid"
        },
        "parentCohortName":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Parent cohort name when the stratum belongs to a cohort.",
            "example":"Adult Cohort"
        },
        "weight":{
            "minimum":0,
            "type":"integer",
            "description":"Weight assigned to the stratum when weighted selection is used.",
            "format":"int32",
            "example":1
        },
        "randomizationType":{
            "maxLength":14,
            "minLength":7,
            "type":"string",
            "description":"Randomization type for the returned stratum. Allowed values: STRATUM = standard stratified randomization stratum, ADAPTIVESTRATUM = adaptive stratified randomization stratum, MINIMIZATION = minimization randomization stratum.",
            "example":"MINIMIZATION",
            "enum":[
                "STRATUM",
                "ADAPTIVESTRATUM",
                "MINIMIZATION"
            ]
        },
        "objectType":{
            "maxLength":12,
            "minLength":8,
            "type":"string",
            "description":"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",
            "enum":[
                "FORMITEM",
                "CLCODEVALUES"
            ]
        },
        "objectId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Object unique identifier associated with the objectType.",
            "format":"uuid"
        },
        "factors":{
            "type":"array",
            "description":"Stratification factors used to define the stratum.",
            "example":[
                {
                    "type":"choice",
                    "formId":"D1B8327AFAA6412287106192AB5984EF",
                    "itemId":"E1B8327AFAA6412287106192AB5984EF",
                    "groupName":"Age Group",
                    "groupId":"F1B8327AFAA6412287106192AB5984EF",
                    "values":[
                        "18-40",
                        "41-65"
                    ],
                    "codelistitemIds":[
                        "977443BF3EFB43888026788E7F7CCE96",
                        "877443BF3EFB43888026788E7F7CCE95"
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/StrataFactorV4"
            }
        }
    },
    "description":"Stratum details returned by the v4 strata read APIs."
}

Nested Schema : factors

Type: array

Stratification factors used to define the stratum.

Show Source

Array of: object StrataFactorV4

Factor details returned for a v4 stratum.

{
    "type":"array",
    "description":"Stratification factors used to define the stratum.",
    "example":[
        {
            "type":"choice",
            "formId":"D1B8327AFAA6412287106192AB5984EF",
            "itemId":"E1B8327AFAA6412287106192AB5984EF",
            "groupName":"Age Group",
            "groupId":"F1B8327AFAA6412287106192AB5984EF",
            "values":[
                "18-40",
                "41-65"
            ],
            "codelistitemIds":[
                "977443BF3EFB43888026788E7F7CCE96",
                "877443BF3EFB43888026788E7F7CCE95"
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/StrataFactorV4"
    }
}

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: array codelistitemIds

Identifiers of the selected code list items for a choice factor.
formId: string (uuid)

Minimum Length: 32

Maximum Length: 32

Form unique identifier that owns the factor item.
groupId: string (uuid)

Minimum Length: 32

Maximum Length: 32

Factor group unique identifier.
groupName: string

Minimum Length: 1

Maximum Length: 64

Factor group display name.

Example: Age Group
itemId: string (uuid)

Minimum Length: 32

Maximum Length: 32

Form item unique identifier for the factor item.
max: number (double)

Maximum numeric value for a range factor. Negative values are allowed when supported by the linked numeric form item's validation range.

Example: 30
min: number (double)

Minimum numeric value for a range factor. Negative values are allowed when supported by the linked numeric form item's validation range.

Example: -5
type: string

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: array values

Selected code list values for a choice factor.

{
    "type":"object",
    "properties":{
        "type":{
            "maxLength":6,
            "minLength":5,
            "type":"string",
            "description":"Factor type. Allowed values: choice = factor based on one or more coded choice values, range = factor based on a numeric range.",
            "example":"choice",
            "enum":[
                "choice",
                "range"
            ]
        },
        "formId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Form unique identifier that owns the factor item.",
            "format":"uuid"
        },
        "itemId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Form item unique identifier for the factor item.",
            "format":"uuid"
        },
        "groupName":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Factor group display name.",
            "example":"Age Group"
        },
        "groupId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Factor group unique identifier.",
            "format":"uuid"
        },
        "values":{
            "type":"array",
            "description":"Selected code list values for a choice factor.",
            "example":[
                "18-40",
                "41-65"
            ],
            "items":{
                "maxLength":255,
                "minLength":1,
                "type":"string",
                "example":"18-40"
            }
        },
        "codelistitemIds":{
            "type":"array",
            "description":"Identifiers of the selected code list items for a choice factor.",
            "example":[
                "977443BF3EFB43888026788E7F7CCE96",
                "877443BF3EFB43888026788E7F7CCE95"
            ],
            "items":{
                "maxLength":32,
                "minLength":32,
                "type":"string",
                "format":"uuid"
            }
        },
        "min":{
            "type":"number",
            "description":"Minimum numeric value for a range factor. Negative values are allowed when supported by the linked numeric form item's validation range.",
            "format":"double",
            "example":-5
        },
        "max":{
            "type":"number",
            "description":"Maximum numeric value for a range factor. Negative values are allowed when supported by the linked numeric form item's validation range.",
            "format":"double",
            "example":30
        }
    },
    "description":"Factor details returned for a v4 stratum."
}

Nested Schema : codelistitemIds

Type: array

Identifiers of the selected code list items for a choice factor.

Show Source

Array of: string(uuid)

Minimum Length: 32

Maximum Length: 32

{
    "type":"array",
    "description":"Identifiers of the selected code list items for a choice factor.",
    "example":[
        "977443BF3EFB43888026788E7F7CCE96",
        "877443BF3EFB43888026788E7F7CCE95"
    ],
    "items":{
        "maxLength":32,
        "minLength":32,
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "977443BF3EFB43888026788E7F7CCE96",
    "877443BF3EFB43888026788E7F7CCE95"
]

Nested Schema : values

Type: array

Selected code list values for a choice factor.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 255

Example: 18-40

{
    "type":"array",
    "description":"Selected code list values for a choice factor.",
    "example":[
        "18-40",
        "41-65"
    ],
    "items":{
        "maxLength":255,
        "minLength":1,
        "type":"string",
        "example":"18-40"
    }
}

Example:

[
    "18-40",
    "41-65"
]

Examples

500 Response

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