Jump to

• Request
• Response

Get metadata of an uploaded file

get

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

Retrieves the metadata of an uploaded file. Right: FileUploadFileGet.

Request

Path Parameters

• objectName(required): string
  Name of the file to be retrieved.

Query Parameters

• mode(required): string
  Mode of the study from which you are uploading the file. Allowed values are active, test and training.
• study(required): string
  Parent file name which can be a study name or any user-defined name.
• studyId(required): string(uuid)
  The ID of the study.

There's no request body for this operation.

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