Jump to

• Request
• Response

[Deprecated]: V1.0

put

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

Deprecated: Use latest version instead. Updates an existing randomization design in the specified study version. The randomId path parameter identifies the design, the request provides the updated randomization details, arms, visits, and settings, and branchIds identifies the visit schedule branches to apply. The response returns the updated randomization design.

Request

Path Parameters

• randomId(required): string(uuid)
  Randomization ID (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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : RandomizationDto v1.0

Type: object

Title: RandomizationDto v1.0

Randomization Design Info

Show Source

• arms: array arms
• details(required): object RandomizationDetails v1.0
  Title: RandomizationDetails v1.0

  Randomization Details DTO
• id: string (uuid)
  Randomization GUID
• settings(required): object RandomizationSettings v1.0
  Title: RandomizationSettings v1.0

  Randomization Settings DTO
• studyId: string (uuid)
  Study ID
• studyVersionStart: string (date-time)
  Study Version Start
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z
• visits: array visits

{
    "title":"RandomizationDto v1.0",
    "required":[
        "details",
        "settings"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "description":"Study ID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study Version Start",
            "format":"date-time"
        },
        "details":{
            "$ref":"#/components/schemas/RandomizationDetailsV1"
        },
        "arms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationArmV1"
            }
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationVisitV1"
            }
        },
        "settings":{
            "$ref":"#/components/schemas/RandomizationSettingsV1"
        }
    },
    "description":"Randomization Design Info"
}

Nested Schema : arms

Type: array

Show Source

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

  Randomization Treatment Arm Ratio

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

Nested Schema : RandomizationDetails v1.0

Type: object

Title: RandomizationDetails v1.0

Randomization Details DTO

Show Source

• algorithm(required): string
  Allowed Values: [ "NONE", "CENTRAL", "CENTRAL_STRATIFIED", "SITE_BLOCKED_FIXED", "SITE_BLOCKED_FIXED_STRATIFIED", "SITE_BLOCKED_DYNAMIC", "SITE_BLOCKED_DYNAMIC_STRATIFIED", "COUNTRY_BLOCKED_FIXED", "COUNTRY_BLOCKED_FIXED_STRATIFIED", "COUNTRY_BLOCKED_DYNAMIC", "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED", "REGION_BLOCKED_FIXED", "REGION_BLOCKED_FIXED_STRATIFIED", "REGION_BLOCKED_DYNAMIC", "REGION_BLOCKED_DYNAMIC_STRATIFIED", "MINIMIZATION" ]

  The algorithm of the randomization design

  Example: Central
• cohortType(required): string
  Allowed Values: [ "NoCohort", "Adaptive", "Demography", "invalid" ]

  The cohort type of the randomization design

  Example: None
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Randomization Design Description

  Example: Method to assign study participants to a treatment group.
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Randomization Title

  Example: Rand 001

{
    "title":"RandomizationDetails v1.0",
    "required":[
        "algorithm",
        "cohortType",
        "title"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Randomization Title",
            "example":"Rand 001"
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Randomization Design Description",
            "example":"Method to assign study participants to a treatment group."
        },
        "algorithm":{
            "type":"string",
            "description":"The algorithm of the randomization design",
            "example":"Central",
            "enum":[
                "NONE",
                "CENTRAL",
                "CENTRAL_STRATIFIED",
                "SITE_BLOCKED_FIXED",
                "SITE_BLOCKED_FIXED_STRATIFIED",
                "SITE_BLOCKED_DYNAMIC",
                "SITE_BLOCKED_DYNAMIC_STRATIFIED",
                "COUNTRY_BLOCKED_FIXED",
                "COUNTRY_BLOCKED_FIXED_STRATIFIED",
                "COUNTRY_BLOCKED_DYNAMIC",
                "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED",
                "REGION_BLOCKED_FIXED",
                "REGION_BLOCKED_FIXED_STRATIFIED",
                "REGION_BLOCKED_DYNAMIC",
                "REGION_BLOCKED_DYNAMIC_STRATIFIED",
                "MINIMIZATION"
            ]
        },
        "cohortType":{
            "type":"string",
            "description":"The cohort type of the randomization design",
            "example":"None",
            "enum":[
                "NoCohort",
                "Adaptive",
                "Demography",
                "invalid"
            ]
        }
    },
    "description":"Randomization Details DTO"
}

Nested Schema : RandomizationSettings v1.0

Type: object

Title: RandomizationSettings v1.0

Randomization Settings DTO

Show Source

• assignSkippedRandomizationNumbers: boolean
  Assign Skipped Randomization Numbers

  Example: false
• randomizeLimitsToCountEarlyTerminated(required): boolean
  Randomize Limits to Count Early Terminated

  Example: false
• randomizeNumberBlinded(required): boolean
  Randomize Number Blinded

  Example: false
• randomizeSubjectsIfSitesOutOfKits(required): boolean
  Restrict Randomization Numbers to Available Kit Types

  Example: false

{
    "title":"RandomizationSettings v1.0",
    "required":[
        "randomizeLimitsToCountEarlyTerminated",
        "randomizeNumberBlinded",
        "randomizeSubjectsIfSitesOutOfKits"
    ],
    "type":"object",
    "properties":{
        "randomizeSubjectsIfSitesOutOfKits":{
            "type":"boolean",
            "description":"Restrict Randomization Numbers to Available Kit Types",
            "example":false
        },
        "assignSkippedRandomizationNumbers":{
            "type":"boolean",
            "description":"Assign Skipped Randomization Numbers",
            "example":false
        },
        "randomizeNumberBlinded":{
            "type":"boolean",
            "description":"Randomize Number Blinded",
            "example":false
        },
        "randomizeLimitsToCountEarlyTerminated":{
            "type":"boolean",
            "description":"Randomize Limits to Count Early Terminated",
            "example":false
        }
    },
    "description":"Randomization Settings DTO"
}

Nested Schema : visits

Type: array

Show Source

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

  Randomization Visit

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

Nested Schema : RandomizationArm v1.0

Type: object

Title: RandomizationArm v1.0

Randomization Treatment Arm Ratio

Show Source

• armVersionStart: string (date-time)
  Arm Version Start
• id(required): string (uuid)
  Treatment Arm GUID
• name: string
  Treatment Arm Name

  Example: Arm1
• ratio(required): integer (int32)
  Minimum Value: 1

  Treatment Arm ratios

  Example: 2
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z

{
    "title":"RandomizationArm v1.0",
    "required":[
        "id",
        "ratio"
    ],
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "armVersionStart":{
            "type":"string",
            "description":"Arm Version Start",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"Treatment Arm Name",
            "example":"Arm1"
        },
        "ratio":{
            "minimum":1,
            "type":"integer",
            "description":"Treatment Arm ratios",
            "format":"int32",
            "example":2
        }
    },
    "description":"Randomization Treatment Arm Ratio"
}

Nested Schema : RandomizationVisit v1.0

Type: object

Title: RandomizationVisit v1.0

Randomization Visit

Show Source

• visitId(required): string (uuid)
  Visit GUID
• visitName: string
  Visit name

  Example: Week 3

{
    "title":"RandomizationVisit v1.0",
    "required":[
        "visitId"
    ],
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "visitName":{
            "type":"string",
            "description":"Visit name",
            "example":"Week 3"
        }
    },
    "description":"Randomization Visit"
}

Examples

Select an example updateRandomizationV1Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : RandomizationDto v1.0

Type: object

Title: RandomizationDto v1.0

Randomization Design Info

Show Source

• arms: array arms
• details(required): object RandomizationDetails v1.0
  Title: RandomizationDetails v1.0

  Randomization Details DTO
• id: string (uuid)
  Randomization GUID
• settings(required): object RandomizationSettings v1.0
  Title: RandomizationSettings v1.0

  Randomization Settings DTO
• studyId: string (uuid)
  Study ID
• studyVersionStart: string (date-time)
  Study Version Start
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z
• visits: array visits

{
    "title":"RandomizationDto v1.0",
    "required":[
        "details",
        "settings"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "description":"Study ID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study Version Start",
            "format":"date-time"
        },
        "details":{
            "$ref":"#/components/schemas/RandomizationDetailsV1"
        },
        "arms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationArmV1"
            }
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationVisitV1"
            }
        },
        "settings":{
            "$ref":"#/components/schemas/RandomizationSettingsV1"
        }
    },
    "description":"Randomization Design Info"
}

Nested Schema : arms

Type: array

Show Source

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

  Randomization Treatment Arm Ratio

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

Nested Schema : RandomizationDetails v1.0

Type: object

Title: RandomizationDetails v1.0

Randomization Details DTO

Show Source

• algorithm(required): string
  Allowed Values: [ "NONE", "CENTRAL", "CENTRAL_STRATIFIED", "SITE_BLOCKED_FIXED", "SITE_BLOCKED_FIXED_STRATIFIED", "SITE_BLOCKED_DYNAMIC", "SITE_BLOCKED_DYNAMIC_STRATIFIED", "COUNTRY_BLOCKED_FIXED", "COUNTRY_BLOCKED_FIXED_STRATIFIED", "COUNTRY_BLOCKED_DYNAMIC", "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED", "REGION_BLOCKED_FIXED", "REGION_BLOCKED_FIXED_STRATIFIED", "REGION_BLOCKED_DYNAMIC", "REGION_BLOCKED_DYNAMIC_STRATIFIED", "MINIMIZATION" ]

  The algorithm of the randomization design

  Example: Central
• cohortType(required): string
  Allowed Values: [ "NoCohort", "Adaptive", "Demography", "invalid" ]

  The cohort type of the randomization design

  Example: None
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Randomization Design Description

  Example: Method to assign study participants to a treatment group.
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Randomization Title

  Example: Rand 001

{
    "title":"RandomizationDetails v1.0",
    "required":[
        "algorithm",
        "cohortType",
        "title"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Randomization Title",
            "example":"Rand 001"
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Randomization Design Description",
            "example":"Method to assign study participants to a treatment group."
        },
        "algorithm":{
            "type":"string",
            "description":"The algorithm of the randomization design",
            "example":"Central",
            "enum":[
                "NONE",
                "CENTRAL",
                "CENTRAL_STRATIFIED",
                "SITE_BLOCKED_FIXED",
                "SITE_BLOCKED_FIXED_STRATIFIED",
                "SITE_BLOCKED_DYNAMIC",
                "SITE_BLOCKED_DYNAMIC_STRATIFIED",
                "COUNTRY_BLOCKED_FIXED",
                "COUNTRY_BLOCKED_FIXED_STRATIFIED",
                "COUNTRY_BLOCKED_DYNAMIC",
                "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED",
                "REGION_BLOCKED_FIXED",
                "REGION_BLOCKED_FIXED_STRATIFIED",
                "REGION_BLOCKED_DYNAMIC",
                "REGION_BLOCKED_DYNAMIC_STRATIFIED",
                "MINIMIZATION"
            ]
        },
        "cohortType":{
            "type":"string",
            "description":"The cohort type of the randomization design",
            "example":"None",
            "enum":[
                "NoCohort",
                "Adaptive",
                "Demography",
                "invalid"
            ]
        }
    },
    "description":"Randomization Details DTO"
}

Nested Schema : RandomizationSettings v1.0

Type: object

Title: RandomizationSettings v1.0

Randomization Settings DTO

Show Source

• assignSkippedRandomizationNumbers: boolean
  Assign Skipped Randomization Numbers

  Example: false
• randomizeLimitsToCountEarlyTerminated(required): boolean
  Randomize Limits to Count Early Terminated

  Example: false
• randomizeNumberBlinded(required): boolean
  Randomize Number Blinded

  Example: false
• randomizeSubjectsIfSitesOutOfKits(required): boolean
  Restrict Randomization Numbers to Available Kit Types

  Example: false

{
    "title":"RandomizationSettings v1.0",
    "required":[
        "randomizeLimitsToCountEarlyTerminated",
        "randomizeNumberBlinded",
        "randomizeSubjectsIfSitesOutOfKits"
    ],
    "type":"object",
    "properties":{
        "randomizeSubjectsIfSitesOutOfKits":{
            "type":"boolean",
            "description":"Restrict Randomization Numbers to Available Kit Types",
            "example":false
        },
        "assignSkippedRandomizationNumbers":{
            "type":"boolean",
            "description":"Assign Skipped Randomization Numbers",
            "example":false
        },
        "randomizeNumberBlinded":{
            "type":"boolean",
            "description":"Randomize Number Blinded",
            "example":false
        },
        "randomizeLimitsToCountEarlyTerminated":{
            "type":"boolean",
            "description":"Randomize Limits to Count Early Terminated",
            "example":false
        }
    },
    "description":"Randomization Settings DTO"
}

Nested Schema : visits

Type: array

Show Source

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

  Randomization Visit

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

Nested Schema : RandomizationArm v1.0

Type: object

Title: RandomizationArm v1.0

Randomization Treatment Arm Ratio

Show Source

• armVersionStart: string (date-time)
  Arm Version Start
• id(required): string (uuid)
  Treatment Arm GUID
• name: string
  Treatment Arm Name

  Example: Arm1
• ratio(required): integer (int32)
  Minimum Value: 1

  Treatment Arm ratios

  Example: 2
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start date

  Example: 2018-11-23T08:43:01.7Z

{
    "title":"RandomizationArm v1.0",
    "required":[
        "id",
        "ratio"
    ],
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "armVersionStart":{
            "type":"string",
            "description":"Arm Version Start",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"Treatment Arm Name",
            "example":"Arm1"
        },
        "ratio":{
            "minimum":1,
            "type":"integer",
            "description":"Treatment Arm ratios",
            "format":"int32",
            "example":2
        }
    },
    "description":"Randomization Treatment Arm Ratio"
}

Nested Schema : RandomizationVisit v1.0

Type: object

Title: RandomizationVisit v1.0

Randomization Visit

Show Source

• visitId(required): string (uuid)
  Visit GUID
• visitName: string
  Visit name

  Example: Week 3

{
    "title":"RandomizationVisit v1.0",
    "required":[
        "visitId"
    ],
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "visitName":{
            "type":"string",
            "description":"Visit name",
            "example":"Week 3"
        }
    },
    "description":"Randomization Visit"
}

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

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

Back to Top