REST API for Clinical One Platform

Get treatment arm ratios for cohort or stratum groups

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}

Retrieves treatment arm ratios associated with a cohort or stratum group in a randomization design.

Request

Path Parameters

groupingsId(required): string(uuid)

Randomization Cohort/Stratum group ID.
randomId(required): string(uuid)

Randomization ID.
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.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object schema

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

Nested Schema : schema

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

Nested Schema : arms

Type: array

Show Source

Array of: object RatioGroupingArmDto v1.0

Title: RatioGroupingArmDto v1.0

Treatment Arm ratio

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

Nested Schema : RatioGroupingArmDto v1.0

Type: object

Title: RatioGroupingArmDto v1.0

Treatment Arm ratio

Show Source

armId: string (uuid)

Treatment Arm GUID
ratio: integer (int32)

Treatment arm ratio

Example: 2

{
    "title":"RatioGroupingArmDto v1.0",
    "type":"object",
    "properties":{
        "armId":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "ratio":{
            "type":"integer",
            "description":"Treatment arm ratio",
            "format":"int32",
            "example":2
        }
    },
    "description":"Treatment Arm ratio"
}

204 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object schema

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

Nested Schema : schema

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

Nested Schema : arms

Type: array

Show Source

Array of: object RatioGroupingArmDto v1.0

Title: RatioGroupingArmDto v1.0

Treatment Arm ratio

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

Nested Schema : RatioGroupingArmDto v1.0

Type: object

Title: RatioGroupingArmDto v1.0

Treatment Arm ratio

Show Source

armId: string (uuid)

Treatment Arm GUID
ratio: integer (int32)

Treatment arm ratio

Example: 2

{
    "title":"RatioGroupingArmDto v1.0",
    "type":"object",
    "properties":{
        "armId":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "ratio":{
            "type":"integer",
            "description":"Treatment arm ratio",
            "format":"int32",
            "example":2
        }
    },
    "description":"Treatment Arm ratio"
}

500 Response

Error

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.