<< Back to GForge REST API

Entity: Filesystem

GET

getFilesystem

Given a file object, returns the thumbnail image representing the file. The following file rules apply:

  1. If an existing thumbnail exists, it is returned.
  2. For image files (PNG, JPG, BMP, etc.), a scaled-down version of the original is created.
  3. For PDF documents, a screen shot of the first page is created, and then scaled as an image.
  4. For Open-Office-compatible files (anything that OpenOffice can read), a temporary PDF is created, and that file is then processed as above.
  5. For all other file types (including unknown or unsupported types), a generic icon for the file type is used.
In all cases, the thumbnail image is saved and returned by subsequent calls for the same ID.

Parameters (1)

Name Type Description
id int The unique identifier for the filesystem entry.

Return: mixed

The binary data for the image that was produced (or already cached).

getThumbnail

Given a file object, returns the thumbnail image representing the file. The following file rules apply:

  1. If an existing thumbnail exists, it is returned.
  2. For image files (PNG, JPG, BMP, etc.), a scaled-down version of the original is created.
  3. For PDF documents, a screen shot of the first page is created, and then scaled as an image.
  4. For Open-Office-compatible files (anything that OpenOffice can read), a temporary PDF is created, and that file is then processed as above.
  5. For all other file types (including unknown or unsupported types), a generic icon for the file type is used.
In all cases, the thumbnail image is saved and returned by subsequent calls for the same ID.

Parameters (1)

Name Type Description
id int The unique identifier for the filesystem entry.

Return: mixed

The binary data for the image that was produced (or already cached).

POST

postFilename

Parameters (0)

Name Type Description
No parameters

Return: (none)

No return type is defined

postFilesystem

Parameters (0)

Name Type Description
No parameters

Return: (none)

No return type is defined

PUT

PUT is not available

DELETE

DELETE is not available