Delete multiple existing cohort groups
delete
/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk
Removes a list of cohort groups associated with a randomization design.
Request
Path Parameters
-
randomId(required): string(uuid)
Randomization ID.
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Supported Media Types
- */*
Root Schema : schema
Type:
Show Source
array
-
Array of:
object CohortDto v1.0
Title:
CohortDto v1.0
Randomization Cohort Details Information
Nested Schema : CohortDto v1.0
Type:
object
Title:
CohortDto v1.0
Randomization Cohort Details Information
Show Source
-
factors: array
factors
-
id: string
(uuid)
Cohort Unique GUID
-
name(required): string
Minimum Length:
1
Maximum Length:64
Cohort NameExample:Cohort Demography Group 1
-
type(required): string
Allowed Values:
[ "None", "Adaptive", "Demography" ]
Cohort TypeExample:Demography
Nested Schema : factors
Type:
Show Source
array
-
Array of:
object CohortFactorDto v1.0
Title:
CohortFactorDto v1.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/CohortChoiceFactorDtoV2", "range":"#/components/schemas/CohortRangeFactorDtoV2" } }
Randomization Cohort Factor Information
Nested Schema : CohortFactorDto v1.0
Type:
object
Title:
CohortFactorDto v1.0
Discriminator: type
Discriminator Values
Randomization Cohort Factor Information
Show Source
-
formId(required): string
(uuid)
Form GUID
-
itemId(required): string
(uuid)
Item GUID
-
type(required): string
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object CohortDto v1.0
Title:
CohortDto v1.0
Randomization Cohort Details Information
Nested Schema : CohortDto v1.0
Type:
object
Title:
CohortDto v1.0
Randomization Cohort Details Information
Show Source
-
factors: array
factors
-
id: string
(uuid)
Cohort Unique GUID
-
name(required): string
Minimum Length:
1
Maximum Length:64
Cohort NameExample:Cohort Demography Group 1
-
type(required): string
Allowed Values:
[ "None", "Adaptive", "Demography" ]
Cohort TypeExample:Demography
Nested Schema : factors
Type:
Show Source
array
-
Array of:
object CohortFactorDto v1.0
Title:
CohortFactorDto v1.0
Discriminator:{ "propertyName":"type", "mapping":{ "choice":"#/components/schemas/CohortChoiceFactorDtoV2", "range":"#/components/schemas/CohortRangeFactorDtoV2" } }
Randomization Cohort Factor Information
Nested Schema : CohortFactorDto v1.0
Type:
object
Title:
CohortFactorDto v1.0
Discriminator: type
Discriminator Values
Randomization Cohort Factor Information
Show Source
-
formId(required): string
(uuid)
Form GUID
-
itemId(required): string
(uuid)
Item GUID
-
type(required): string
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-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.