Jump to

• Request
• Response

Get list of all treatment arm ratios for cohort or stratum groups

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizationRatios

Retrieves a list of treatment arm ratios associated with all cohort or stratum groups in a randomization design.

Request

Path Parameters

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

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 RandomizationsGroupingDto v3.0
  Title: RandomizationsGroupingDto v3.0

  Randomization Grouping Ratios

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

Nested Schema : RandomizationsGroupingDto v3.0

Type: object

Title: RandomizationsGroupingDto v3.0

Randomization Grouping Ratios

Show Source

• randomizationFactorCount: integer (int64)
• randomizationId: string (uuid)
  Randomization GUID
• ratios: array ratios

{
    "title":"RandomizationsGroupingDto v3.0",
    "type":"object",
    "properties":{
        "randomizationId":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "ratios":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatioGroupingDtoV3"
            }
        },
        "randomizationFactorCount":{
            "type":"integer",
            "format":"int64"
        }
    },
    "description":"Randomization Grouping Ratios"
}

Nested Schema : ratios

Type: array

Show Source

• Array of: object RatioGroupingDtoV3

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

Nested Schema : RatioGroupingDtoV3

Type: object

Show Source

• arms: array arms
• groupingId: string (uuid)
  Randomization Cohort/Stratum group GUID

{
    "type":"object",
    "properties":{
        "groupingId":{
            "type":"string",
            "description":"Randomization Cohort/Stratum group GUID",
            "format":"uuid"
        },
        "arms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatioGroupingArmDtoV2"
            }
        }
    }
}

Nested Schema : arms

Type: array

Show Source

• Array of: object RatioGroupingArmDto v2.0
  Title: RatioGroupingArmDto v2.0

  Treatment Arm ratio

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

Nested Schema : RatioGroupingArmDto v2.0

Type: object

Title: RatioGroupingArmDto v2.0

Treatment Arm ratio

Show Source

• armId: string (uuid)
  Treatment Arm GUID
• mappedArms: array mappedArms
• ratio: integer (int32)
  Treatment arm ratio

  Example: 2

{
    "title":"RatioGroupingArmDto v2.0",
    "type":"object",
    "properties":{
        "armId":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "ratio":{
            "type":"integer",
            "description":"Treatment arm ratio",
            "format":"int32",
            "example":"2"
        },
        "mappedArms":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Arms mapped to this arm",
                "format":"uuid"
            }
        }
    },
    "description":"Treatment Arm ratio"
}

Nested Schema : mappedArms

Type: array

Show Source

• Array of: string(uuid)
  Arms mapped to this arm

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Arms mapped to this arm",
        "format":"uuid"
    }
}

204 Response

Successful operation.

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