Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/csvuniquevalues

Retrieves unique values for treatment arms, strata, 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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
• studyVersion(required): string
  Version of the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Randomization List Upload Request

Type: object

Title: Randomization List Upload Request

Contains randomization list mapping detail such as headers, treatment, stratums and cohorts.

Show Source

• cohortMappings: array cohortMappings
• containsHeader: boolean
• containsHeadersRow(required): string
  Allowed Values: [ "y", "n", "Y", "N" ]

  Pattern: [yYnN]

  Contains Headers Row.

  Example: y
• fileId(required): string (uuid)
  Unique ID for field.
• headerMappings: array headerMappings
• headerMappingsMap: object headerMappingsMap
  Additional Properties Allowed: HeaderMapping
• stratumMappings: array stratumMappings
• treatmentMappings: array treatmentMappings

{
    "title":"Randomization List Upload Request",
    "required":[
        "containsHeadersRow",
        "fileId"
    ],
    "type":"object",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"Unique ID for field.",
            "format":"uuid"
        },
        "containsHeadersRow":{
            "pattern":"[yYnN]",
            "type":"string",
            "description":"Contains Headers Row.",
            "example":"y",
            "enum":[
                "y",
                "n",
                "Y",
                "N"
            ]
        },
        "headerMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "treatmentMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataMapping"
            }
        },
        "stratumMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataMapping"
            }
        },
        "cohortMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataMapping"
            }
        },
        "containsHeader":{
            "type":"boolean"
        },
        "headerMappingsMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        }
    },
    "description":"Contains randomization list mapping detail such as headers, treatment, stratums and cohorts."
}

Nested Schema : cohortMappings

Type: array

Show Source

• Array of: object DataMapping
  Contains data mapping.

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

Nested Schema : headerMappings

Type: array

Show Source

• Array of: object HeaderMapping
  Contains header mapping.

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

Nested Schema : headerMappingsMap

Type: object

Additional Properties Allowed

Show Source

• object HeaderMapping
  Contains header mapping.

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/HeaderMapping"
    }
}

Nested Schema : stratumMappings

Type: array

Show Source

• Array of: object DataMapping
  Contains data mapping.

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

Nested Schema : treatmentMappings

Type: array

Show Source

• Array of: object DataMapping
  Contains data mapping.

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

Nested Schema : DataMapping

Type: object

Contains data mapping.

Show Source

• dataFromFile: string
  Data from file.

  Example: TA
• dataId: string (uuid)
  Unique data Id.

{
    "type":"object",
    "properties":{
        "dataFromFile":{
            "type":"string",
            "description":"Data from file.",
            "example":"TA"
        },
        "dataId":{
            "type":"string",
            "description":"Unique data Id.",
            "format":"uuid"
        }
    },
    "description":"Contains data mapping."
}

Nested Schema : HeaderMapping

Type: object

Contains header mapping.

Show Source

• dbHeader(required): string
  DB header

  Example: Kit Number
• fileHeader(required): string
  File header

  Example: Kit Number

{
    "required":[
        "dbHeader",
        "fileHeader"
    ],
    "type":"object",
    "properties":{
        "fileHeader":{
            "type":"string",
            "description":"File header",
            "example":"Kit Number"
        },
        "dbHeader":{
            "type":"string",
            "description":"DB header",
            "example":"Kit Number"
        }
    },
    "description":"Contains header mapping."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : RndListMappingResponse

Type: object

Title: RndListMappingResponse

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.

{
    "title":"RndListMappingResponse",
    "type":"object",
    "properties":{
        "treatments":{
            "title":"Treatments",
            "type":"array",
            "description":"Contains treatment.",
            "items":{
                "type":"string"
            }
        },
        "stratums":{
            "title":"Stratums",
            "type":"array",
            "description":"Contains stratums.",
            "items":{
                "type":"string"
            }
        },
        "cohorts":{
            "title":"Cohorts",
            "type":"array",
            "description":"Contains cohorts.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Contains randomization list mapping detail with treatment, stratum and cohort."
}

Nested Schema : Cohorts

Type: array

Title: Cohorts

Contains cohorts.

Show Source

• Array of: string

{
    "title":"Cohorts",
    "type":"array",
    "description":"Contains cohorts.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Stratums

Type: array

Title: Stratums

Contains stratums.

Show Source

• Array of: string

{
    "title":"Stratums",
    "type":"array",
    "description":"Contains stratums.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Treatments

Type: array

Title: Treatments

Contains treatment.

Show Source

• Array of: string

{
    "title":"Treatments",
    "type":"array",
    "description":"Contains treatment.",
    "items":{
        "type":"string"
    }
}

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

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

404 Response

Study not found. Or randomization design not found. Or design not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top