Jump to

• Request
• Response

V1.0

put

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

Updates treatment arm ratios associated with adaptive cohorts in a randomization design.

Request

Path Parameters

• randomId(required): string(uuid)
  Randomization identifier (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  8E1A7B6C2D3F4A55B12C9D4E6F708192

• 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

Query Parameters

• groupingsId: string(uuid)
  Randomization cohort/stratum grouping identifier (UUID, 32-character uppercase hexadecimal string). Optional.

  Example:

  7A4D3C2B1E8F4D56A23C9F3A0C7D4E22

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

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

  Cohort group details.

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

Nested Schema : RqstCohortGroupingDto v1.0

Type: object

Title: RqstCohortGroupingDto v1.0

Cohort group details.

Show Source

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

  Example: Cohort Group 1

{
    "title":"RqstCohortGroupingDto v1.0",
    "type":"object",
    "properties":{
        "groupingId":{
            "type":"string",
            "description":"Randomization Cohort/Stratum group GUID",
            "format":"uuid"
        },
        "arms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatioGroupingArmDtoV2"
            }
        },
        "groupingName":{
            "type":"string",
            "description":"Cohort group name",
            "example":"Cohort Group 1"
        }
    },
    "description":"Cohort group details."
}

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

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Cohort group details.

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

Nested Schema : RqstCohortGroupingDto v1.0

Type: object

Title: RqstCohortGroupingDto v1.0

Cohort group details.

Show Source

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

  Example: Cohort Group 1

{
    "title":"RqstCohortGroupingDto v1.0",
    "type":"object",
    "properties":{
        "groupingId":{
            "type":"string",
            "description":"Randomization Cohort/Stratum group GUID",
            "format":"uuid"
        },
        "arms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatioGroupingArmDtoV2"
            }
        },
        "groupingName":{
            "type":"string",
            "description":"Cohort group name",
            "example":"Cohort Group 1"
        }
    },
    "description":"Cohort group details."
}

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

Examples

Select an example successResponse

204 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Cohort group details.

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

Nested Schema : RqstCohortGroupingDto v1.0

Type: object

Title: RqstCohortGroupingDto v1.0

Cohort group details.

Show Source

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

  Example: Cohort Group 1

{
    "title":"RqstCohortGroupingDto v1.0",
    "type":"object",
    "properties":{
        "groupingId":{
            "type":"string",
            "description":"Randomization Cohort/Stratum group GUID",
            "format":"uuid"
        },
        "arms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RatioGroupingArmDtoV2"
            }
        },
        "groupingName":{
            "type":"string",
            "description":"Cohort group name",
            "example":"Cohort Group 1"
        }
    },
    "description":"Cohort group details."
}

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

Examples

Select an example successResponse

500 Response

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

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