Drop Box List

Endpoint to view the information about a users dropbox.

A DropBox is a location on the storage system in which the user can place files and subsequently load them into the application. Mainly used for large files.

Dropbox information

• GET /api/v2/data_management/dropbox/

  Get the user dropbox information.

  As admin, the query parameter username can be used to view dropbox folders of other users ?username=username

• GET /api/v2/data_management/dropbox/c2068af7-3d5b-4c47-b678-91120912d4a6/

  Get the same information as with the above url, this is however the base url for the further listings

• GET /api/v2/data_management/dropbox/c2068af7-3d5b-4c47-b678-91120912d4a6/size

  Calculate the size on disk for this dropbox.

List content

• GET /api/v2/data_management/dropbox/c2068af7-3d5b-4c47-b678-91120912d4a6/files/?folder=foldername

  Get the content listed in this dropbox folder. Depending on the file format different meta data will be shown.

  Query parameters:

  • folder (required): The folder path to list
  • recursive (optional): If true, recursively list content in subdirectories (default: false)
    • When used WITHOUT extension, both files and folders are listed recursively
    • When used WITH extension, only files matching the extension are listed
  • extension (optional): Filter files by extension (case-insensitive) when using recursive mode (e.g., txt, .fastq.gz, TXT)
    • Only applicable when recursive=true
    • When provided, only files matching this extension are returned, and folders are excluded

  Common metadata are: name, ext, basename, uri, size, modified, created, relativePath