REST API for Clinical One Platform

Upload randomization list based on header mappings and treatment, cohort, stratum mappings

post

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

Uploads a randomization list in Oracle Clinical One Platform based on the mapped headers and treatment, cohort, stratum mappings. 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 Row

Example: 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

{
    "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, 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."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : GenerateResponse

Type: object

Response Object for created randomization list.

Show Source

listId: string

Unique Id of generated randomization list

Example: 9ECA4FA65076451DA7D47D59367D15A5
noOfRowsGenerated: integer (int32)

Number of rows generated for randomization list.

Example: 5

{
    "type":"object",
    "properties":{
        "listId":{
            "type":"string",
            "description":"Unique Id of generated randomization list",
            "example":"9ECA4FA65076451DA7D47D59367D15A5"
        },
        "noOfRowsGenerated":{
            "type":"integer",
            "description":"Number of rows generated for randomization list.",
            "format":"int32",
            "example":5
        }
    },
    "description":"Response Object for created randomization list."
}

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

Title: ErrorResponseData

Error Response Details Information
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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

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

Title: ErrorResponseData

Error Response Details Information
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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.