Jump to

• Request
• Response

Upload a file to the system

put

/ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}

Uploads a file in the context of bucket name. Right: FileUploadFilePost.

Request

Path Parameters

• bucketName(required): string
  Bucket Name. Tenant or study or user defined user name.
• objectName(required): string
  Name of the file to be uploaded.

Query Parameters

• fileType: string
  Reserved for future usage. Type of file indicating whether the file is a Site, Depot or Countries CSV.
• mode(required): string
  Mode of the study from which you are uploading the file. Allowed values are active, test and training.
• notificationRequired: boolean
  Reserved for future usage. Indicates whether notification needs to be sent to user or not. Allowed value is either true or false.
• overwrite: boolean
  Set to true if any existing file part has to be overwritten with the same name.
• serviceName: string
  Reserved for future usage. Name of the service which uses the uploaded file.
• studyId(required): string(uuid)
  The ID of the study.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : ObjectModel

Type: object

Show Source

• bucketName: string
• checksum: string
• createdBy: string
• createdOn: string (date-time)
• errorMsg: string
• fileType: string
• getlifeCycle: string
• guid: string
• name: string
• notificationRequired: string
• self: string
• serviceName: string
• size: integer (int64)
• status: string
• study: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "self":{
            "type":"string"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        },
        "study":{
            "type":"string"
        },
        "bucketName":{
            "type":"string"
        },
        "getlifeCycle":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "checksum":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "guid":{
            "type":"string"
        },
        "errorMsg":{
            "type":"string"
        },
        "fileType":{
            "type":"string"
        },
        "serviceName":{
            "type":"string"
        },
        "notificationRequired":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized user.

500 Response

Internal server error.

Back to Top