Jump to

• Request
• Response

Get all active strata in a study

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/strata

Retrieves a list of study strata. You can retrieve this list by study mode.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

• mode(required): string
  Study version mode to filter strata.

  Allowed Values: [ "test", "training", "active" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StratumDtoV1

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

Nested Schema : StratumDtoV1

Type: object

Show Source

• factors(required): array factors
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647
• id: string (uuid)
  Stratum Unique GUID
• name(required): string
  Minimum Length: 1

  Maximum Length: 64

  Stratum Name

  Example: Stratum Group 1

{
    "required":[
        "factors",
        "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":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StratumFactorDtoV1"
            }
        }
    }
}

Nested Schema : factors

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object StratumFactorDto v1.0
  Title: StratumFactorDto v1.0

  Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV1", "range":"#/components/schemas/StratumRangeFactorDtoV1" } }

  Randomization Stratum Factor Information

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StratumFactorDtoV1"
    }
}

Nested Schema : StratumFactorDto v1.0

Type: object

Title: StratumFactorDto v1.0

Discriminator: type

Discriminator Values

• choice
• range

{
    "title":"StratumFactorDto v1.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"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Stratum Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/StratumChoiceFactorDtoV1",
            "range":"#/components/schemas/StratumRangeFactorDtoV1"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/StratumChoiceFactorDtoV1"
        },
        {
            "$ref":"#/components/schemas/StratumRangeFactorDtoV1"
        }
    ]
}

Randomization Stratum Factor Information

Show Source

• formId(required): string (uuid)
  Form GUID
• itemId(required): string (uuid)
  Form item GUID
• type(required): string

{
    "title":"StratumFactorDto v1.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"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Stratum Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/StratumChoiceFactorDtoV1",
            "range":"#/components/schemas/StratumRangeFactorDtoV1"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/StratumChoiceFactorDtoV1"
        },
        {
            "$ref":"#/components/schemas/StratumRangeFactorDtoV1"
        }
    ]
}

Match One Schema

Show Source

• object StratumChoiceFactorDto v1.0
  Title: StratumChoiceFactorDto v1.0

  Stratum Choice Factor Detail Information
• object StratumRangeFactorDto v1.0
  Title: StratumRangeFactorDto v1.0

  Stratum Range Factor Detail Information

{
    "title":"StratumFactorDto v1.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"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Stratum Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/StratumChoiceFactorDtoV1",
            "range":"#/components/schemas/StratumRangeFactorDtoV1"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/StratumChoiceFactorDtoV1"
        },
        {
            "$ref":"#/components/schemas/StratumRangeFactorDtoV1"
        }
    ]
}

Nested Schema : StratumChoiceFactorDto v1.0

Type: object

Title: StratumChoiceFactorDto v1.0

Stratum Choice Factor Detail Information

Match All

Show Source

• object StratumFactorDto v1.0
  Title: StratumFactorDto v1.0

  Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV1", "range":"#/components/schemas/StratumRangeFactorDtoV1" } }

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

{
    "title":"StratumChoiceFactorDto v1.0",
    "required":[
        "formId",
        "itemId",
        "values"
    ],
    "type":"object",
    "description":"Stratum Choice Factor Detail Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/StratumFactorDtoV1"
        },
        {
            "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"
                    }
                }
            }
        }
    ]
}

Nested Schema : StratumRangeFactorDto v1.0

Type: object

Title: StratumRangeFactorDto v1.0

Stratum Range Factor Detail Information

Match All

Show Source

• object StratumFactorDto v1.0
  Title: StratumFactorDto v1.0

  Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/StratumChoiceFactorDtoV1", "range":"#/components/schemas/StratumRangeFactorDtoV1" } }

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

{
    "title":"StratumRangeFactorDto v1.0",
    "required":[
        "formId",
        "itemId",
        "max",
        "min"
    ],
    "type":"object",
    "description":"Stratum Range Factor Detail Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/StratumFactorDtoV1"
        },
        {
            "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 v1.0-allOf[1]

Type: object

Show Source

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

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

500 Response

Error

Body ()

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

Back to Top