REST API for Clinical One Platform

Upload randomization list file from a file service into RTSM

post

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

Uploads randomization list as a CSV file from File Service into ORS. 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

Logo uploaded to fileupload service response name

Show Source

contentType: string

File Content-Type
fileName(required): string

File name

Example: File1001
mode(required): string

Mode of the study, accepts: test, active, or training

Example: test, active, or training
name(required): string

Random name for bucket where file uploaded

Example: 1A73BC4FE4954AE4AC50DDF9729F80BE

{
    "required":[
        "fileName",
        "mode",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Random name for bucket where file uploaded",
            "example":"1A73BC4FE4954AE4AC50DDF9729F80BE"
        },
        "mode":{
            "type":"string",
            "description":"Mode of the study, accepts: test, active, or training",
            "example":"test, active, or training"
        },
        "fileName":{
            "type":"string",
            "description":"File name",
            "example":"File1001"
        },
        "contentType":{
            "type":"string",
            "description":"File Content-Type"
        }
    },
    "description":"Logo uploaded to fileupload service response name"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : FileUploadResponse

Type: object

Contains file upload response

Show Source

fileId: string

Field id

Example: 7074779C195A4BF2B5EB0CEFB34BD47F

{
    "type":"object",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"Field id",
            "example":"7074779C195A4BF2B5EB0CEFB34BD47F"
        }
    },
    "description":"Contains file upload response"
}

400 Response

Randomization list can't be generated/uploaded as there is no algorithm for the randomization design.Or you must associate the randomization design with a visit before you can create/upload a randomization list for itOr randomization list already exists

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

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

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