Jump to

• Request
• Response

v1.0

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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• rndDesignId(required): string(uuid)
  ID of the randomization design.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyVersion(required): string
  Version of the study.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Logo upload request details.

Show Source

• contentType: string
  File content type.

  Example: image/png
• fileName(required): string
  File name

  Example: File1001
• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, 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":"Indicates the operational mode of the study. Accepted values: active, test, or training.",
            "example":"test, active, or training"
        },
        "fileName":{
            "type":"string",
            "description":"File name",
            "example":"File1001"
        },
        "contentType":{
            "type":"string",
            "description":"File content type.",
            "example":"image/png"
        }
    },
    "description":"Logo upload request details.",
    "example":{
        "name":"1A73BC4FE4954AE4AC50DDF9729F80BE",
        "mode":"design",
        "fileName":"study-logo.png",
        "contentType":"image/png"
    }
}

Example:

{
    "name":"1A73BC4FE4954AE4AC50DDF9729F80BE",
    "mode":"design",
    "fileName":"study-logo.png",
    "contentType":"image/png"
}

Examples

Select an example Upload File Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : FileUploadResponse

Type: object

Title: FileUploadResponse

Contains file upload response.

Show Source

• fileId: string
  Title: File ID

  Field ID.

  Example: 7074779C195A4BF2B5EB0CEFB34BD47F

{
    "title":"FileUploadResponse",
    "type":"object",
    "properties":{
        "fileId":{
            "title":"File ID",
            "type":"string",
            "description":"Field ID.",
            "example":"7074779C195A4BF2B5EB0CEFB34BD47F"
        }
    },
    "description":"Contains file upload response."
}

Examples

Select an example Upload File 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

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

Examples

Select an example Upload File Bad Request Response

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

Examples

Select an example Upload File Study Or Design Not Found Response Upload File Source File Not Found Response

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

Examples

Select an example Upload File Server Error Response

Back to Top