CLclowder-framework
files

Retrieve physical file object metadata

Changed on

Get information of the file object (not the resource it describes) as JSON. For example, size of file, date created, content type, filename.

get/files/{id}/metadata

Request

  • Base URL
    https://clowder.ncsa.illinois.edu/clowder/api
  • Auth
    • HTTP basic
    • or API key in header X-API-Key
    • or API key in query parameter key

Path parameters

idstring required

Response

Successfully returns a list of files

idstring
filenamestring
filepathstring

only specified if user is serveradmin, and storage is DiskByteStorageService

service-endpointstring

only specified if user is serveradmin, and storage is S3ByteStorageService

bucket-namestring

only specified if user is serveradmin, and storage is S3ByteStorageService

object-keystring

only specified if user is serveradmin, and storage is S3ByteStorageService

filedescriptionstring
content-typestring
date-createdstring
sizestring int64
authorIdstring

id of user who uploaded the file

thumbnailstring

optinal id of the thumbnail image of this file

statusstring

status of the file, this can be one of the following:

  • CREATED file is created, but blob is not in final place yes
  • PROCESSING blob is in final place, final processing is done such as sending messagess to RabbitMQ
  • PROCESSED file is fully procesed by clowder

Example response

{
  "id": "5b8e969d5e0e8690971ee23e",
  "filename": "cat.jpg",
  "filepath": "/home/clowder/data/uploads/41/e2/1e/5b8e969d5e0e8690971ee241",
  "filedescription": "Picture of a cat",
  "content-type": "image/jpeg",
  "date-created": "Tue Sep 04 09:28:45 CDT 2018",
  "size": "190497",
  "authorId": "5447f889fa429866bbd44dbd",
  "thumbnail": "5bfd5a2640c6cd6147bb27e0",
  "status": "PROCESSED"
}

Changes

  • e9162684017eRevision changes
    • info

      added the optional property to the response with the status

  • 290a2ff6cbe0Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status