Get unique values for treatments, stratums or cohorts from a CSV file
post
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/csvuniquevalues
Retrieves unique values for treatment arms, stratums, and/or cohorts for a randomization list in a CSV file. Rights: DesignerRandListUpload.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
rndDesignId(required): string(uuid)
ID of the randomization design
-
studyId(required): string(uuid)
ID of the study
-
studyVersion(required): string
Version of the study
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Contains randomization list mapping detail such as headers, treatment, stratums and cohorts
Show Source
-
cohortMappings: array
cohortMappings
-
containsHeader: boolean
-
containsHeadersRow(required): string
Pattern:
[yYnN]
Contains Headers RowExample:y, n
-
fileId(required): string
(uuid)
Unique Id for field
-
headerMappings: array
headerMappings
-
headerMappingsMap: object
headerMappingsMap
Additional Properties Allowed: HeaderMapping
-
stratumMappings: array
stratumMappings
-
treatmentMappings: array
treatmentMappings
Nested Schema : cohortMappings
Type:
Show Source
array
-
Array of:
object DataMapping
Contains data mapping.
Nested Schema : headerMappings
Type:
Show Source
array
-
Array of:
object HeaderMapping
Contains header mapping.
Nested Schema : headerMappingsMap
Type:
object
Additional Properties Allowed
Show Source
-
object HeaderMapping
Contains header mapping.
Nested Schema : stratumMappings
Type:
Show Source
array
-
Array of:
object DataMapping
Contains data mapping.
Nested Schema : treatmentMappings
Type:
Show Source
array
-
Array of:
object DataMapping
Contains data mapping.
Nested Schema : DataMapping
Type:
object
Contains data mapping.
Show Source
-
dataFromFile: string
Data from file.Example:
TA
-
dataId: string
(uuid)
Unique data Id.
Nested Schema : HeaderMapping
Type:
object
Contains header mapping.
Show Source
-
dbHeader(required): string
DB headerExample:
Kit Number
-
fileHeader(required): string
File headerExample:
Kit Number
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : RndListMappingResponse
Type:
object
Contains randomization list mapping detail with treatment, stratum and cohort
Show Source
-
cohorts: array
cohorts
Title:
cohorts
Contains cohorts. -
stratums: array
stratums
Title:
stratums
Contains stratums. -
treatments: array
treatments
Title:
treatments
Contains treatment.
400 Response
Randomization list can't be generated/uploaded as there is no algorithm for the randomization designOr you must associate the randomization design with a visit before you can create/upload a randomization list for itOr the file can't be uploaded because it contains invalid content, such as special characters, empty cells, or empty rowsOr empty CSV content
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
Study not found. Or randomization design not found. Or design not found
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object