REST API for Clinical One Cloud Service

V2.0

get

/ec-designer-svc/rest/v2.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

randomId(required): string(uuid)
Randomization ID (UUID, 32-character uppercase hexadecimal string). Required.
Example:
```
8E1A7B6C2D3F4A55B12C9D4E6F708192
```
stratumId(required): string(uuid)
Stratum ID (UUID, 32-character uppercase hexadecimal string). Required.
Example:
```
5C2D1E8F4A6B4D56A23C9F3A0C7D4E44
```
studyId(required): string(uuid)
Study ID (UUID, 32-character uppercase hexadecimal string). Required.
Example:
```
F054C951EB74443C93716CA714AB686E
```
version(required): string
Study version path segment. Required. Example: "1.0.0.1".
Example:
```
1.0.0.1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : RespStratumDto

Type: object

Show Source

factors: array factors
id: string (uuid)

Stratum Unique GUID
name(required): string

Minimum Length: 1

Maximum Length: 64

Stratum Name

Example: Stratum Group 1
objectId: string

Value of Object GUID

Example: B1B8327AFAA6412287106192AB5984EF
objectType: string

Type of Object

Example: Code List
randomizationType: string

Type of Stratum

Example: Stratified
weight: string

Weight of Stratum Group

Example: 1

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Stratum Unique GUID",
            "format":"uuid"
        },
        "name":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Stratum Name",
            "example":"Stratum Group 1"
        },
        "factors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StratumFactorDtoV3"
            }
        },
        "weight":{
            "type":"string",
            "description":"Weight of Stratum Group",
            "example":"1"
        },
        "randomizationType":{
            "type":"string",
            "description":"Type of Stratum",
            "example":"Stratified"
        },
        "objectType":{
            "type":"string",
            "description":"Type of Object",
            "example":"Code List"
        },
        "objectId":{
            "type":"string",
            "description":"Value of Object GUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    }
}

Nested Schema : factors

Type: array

Show Source

Array of: object StratumFactorDto v3.0

Title: StratumFactorDto v3.0

Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }

Randomization Stratum Factor Information

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

Nested Schema : StratumFactorDto v3.0

Type: object

Title: StratumFactorDto v3.0

Discriminator: type

{
    "title":"StratumFactorDto v3.0",
    "required":[
        "formId",
        "itemId",
        "type"
    ],
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Form item GUID",
            "format":"uuid"
        },
        "groupName":{
            "type":"string",
            "description":"Stratum Name",
            "example":"Stratum Group 1"
        },
        "groupId":{
            "type":"string",
            "description":"Stratum Group Id",
            "format":"uuid"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Stratum Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/StratumChoiceFactorDtoV3",
            "range":"#/components/schemas/StratumRangeFactorDtoV3"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/StratumChoiceFactorDtoV3"
        },
        {
            "$ref":"#/components/schemas/StratumRangeFactorDtoV3"
        }
    ]
}

Randomization Stratum Factor Information

Show Source

formId(required): string (uuid)

Form GUID
groupId: string (uuid)

Stratum Group Id
groupName: string

Stratum Name

Example: Stratum Group 1
itemId(required): string (uuid)

Form item GUID
type(required): string

{
    "title":"StratumFactorDto v3.0",
    "required":[
        "formId",
        "itemId",
        "type"
    ],
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Form item GUID",
            "format":"uuid"
        },
        "groupName":{
            "type":"string",
            "description":"Stratum Name",
            "example":"Stratum Group 1"
        },
        "groupId":{
            "type":"string",
            "description":"Stratum Group Id",
            "format":"uuid"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Stratum Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/StratumChoiceFactorDtoV3",
            "range":"#/components/schemas/StratumRangeFactorDtoV3"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/StratumChoiceFactorDtoV3"
        },
        {
            "$ref":"#/components/schemas/StratumRangeFactorDtoV3"
        }
    ]
}

Match One Schema

Show Source

object StratumChoiceFactorDto v3.0

Title: StratumChoiceFactorDto v3.0

Stratum Choice Factor Detail Information
object StratumRangeFactorDto v3.0

Title: StratumRangeFactorDto v3.0

Stratum Range Factor Detail Information

{
    "title":"StratumFactorDto v3.0",
    "required":[
        "formId",
        "itemId",
        "type"
    ],
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Form item GUID",
            "format":"uuid"
        },
        "groupName":{
            "type":"string",
            "description":"Stratum Name",
            "example":"Stratum Group 1"
        },
        "groupId":{
            "type":"string",
            "description":"Stratum Group Id",
            "format":"uuid"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Stratum Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/StratumChoiceFactorDtoV3",
            "range":"#/components/schemas/StratumRangeFactorDtoV3"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/StratumChoiceFactorDtoV3"
        },
        {
            "$ref":"#/components/schemas/StratumRangeFactorDtoV3"
        }
    ]
}

Nested Schema : StratumChoiceFactorDto v3.0

Type: object

Title: StratumChoiceFactorDto v3.0

Stratum Choice Factor Detail Information

Match All

Stratum Choice Factor Detail Information

Show Source

object StratumFactorDto v3.0

Title: StratumFactorDto v3.0

Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }

Randomization Stratum Factor Information
object StratumChoiceFactorDto v3.0-allOf[1]

{
    "title":"StratumChoiceFactorDto v3.0",
    "required":[
        "codelistitemIds",
        "formId",
        "itemId",
        "values"
    ],
    "type":"object",
    "description":"Stratum Choice Factor Detail Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/StratumFactorDtoV3"
        },
        {
            "type":"object",
            "properties":{
                "values":{
                    "maxItems":2147483647,
                    "minItems":1,
                    "type":"array",
                    "items":{
                        "maxLength":2147483647,
                        "minLength":1,
                        "type":"string",
                        "description":"Selected from choice factor's code list choice values",
                        "example":"1"
                    }
                },
                "codelistitemIds":{
                    "maxItems":2147483647,
                    "minItems":1,
                    "type":"array",
                    "items":{
                        "type":"string",
                        "description":"Selected from choice factor's code list choice codelistItem Ids",
                        "format":"uuid"
                    }
                }
            }
        }
    ]
}

Nested Schema : StratumRangeFactorDto v3.0

Type: object

Title: StratumRangeFactorDto v3.0

Stratum Range Factor Detail Information

Match All

Stratum Range Factor Detail Information

Show Source

object StratumFactorDto v3.0

Title: StratumFactorDto v3.0

Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV3", "range":"#/components/schemas/StratumRangeFactorDtoV3" } }

Randomization Stratum Factor Information
object StratumRangeFactorDto v3.0-allOf[1]

{
    "title":"StratumRangeFactorDto v3.0",
    "required":[
        "formId",
        "itemId",
        "max",
        "min"
    ],
    "type":"object",
    "description":"Stratum Range Factor Detail Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/StratumFactorDtoV3"
        },
        {
            "type":"object",
            "properties":{
                "min":{
                    "type":"number",
                    "description":"Stratum Factor Min value",
                    "format":"double",
                    "example":20
                },
                "max":{
                    "type":"number",
                    "description":"Stratum Factor Max value",
                    "format":"double",
                    "example":120
                }
            }
        }
    ]
}

Nested Schema : StratumChoiceFactorDto v3.0-allOf[1]

Type: object

Show Source

codelistitemIds: array codelistitemIds

Minimum Number of Items: 1

Maximum Number of Items: 2147483647
values: array values

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

{
    "type":"object",
    "properties":{
        "values":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "maxLength":2147483647,
                "minLength":1,
                "type":"string",
                "description":"Selected from choice factor's code list choice values",
                "example":"1"
            }
        },
        "codelistitemIds":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "type":"string",
                "description":"Selected from choice factor's code list choice codelistItem Ids",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : codelistitemIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

Array of: string(uuid)

Selected from choice factor's code list choice codelistItem Ids

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "type":"string",
        "description":"Selected from choice factor's code list choice codelistItem Ids",
        "format":"uuid"
    }
}

Nested Schema : values

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 2147483647

Selected from choice factor's code list choice values

Example: 1

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "maxLength":2147483647,
        "minLength":1,
        "type":"string",
        "description":"Selected from choice factor's code list choice values",
        "example":"1"
    }
}

Nested Schema : StratumRangeFactorDto v3.0-allOf[1]

Type: object

Show Source

max: number (double)

Stratum Factor Max value

Example: 120
min: number (double)

Stratum Factor Min value

Example: 20

{
    "type":"object",
    "properties":{
        "min":{
            "type":"number",
            "description":"Stratum Factor Min value",
            "format":"double",
            "example":20
        },
        "max":{
            "type":"number",
            "description":"Stratum Factor Max value",
            "format":"double",
            "example":120
        }
    }
}

Examples

500 Response

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

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"
}