MindTouch Developer Center > MindTouch Deki > API Reference > GET:files/{fileid}/{filename}

GET:files/{fileid}/{filename}

Overview

public. Retrieve file attachment content

Uri Parameters
NameTypeDescription
fileidintidentifies a file by ID
filenamestring"=" followed by a double uri-encoded file name
Query Parameters
NameTypeDescription
format{jpg, png, bmp, gif}?Convert output to given type. Default is to use original type.
heightint?Height of the image
ratio{fixed, var}?Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).
revisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
size{original, thumb, webview, bestfit, custom}?Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
widthint?Width of the image
Return Codes
NameValueDescription
BadRequest400Invalid input parameter or request body
Forbidden403Read access to the page is required
NotFound404Requested file could not be found
NotImplemented501Requested operation is not currently supported
Ok200The request completed successfully

Message Format

None

Implementation Notes

This feature is identical to GET:files/{fileid}; refer to this feature for more information.  The {filename} uri parameter is not used and is intended for informational purposes only.

Code Samples

None

Tag page
You must login to post a comment.
Powered by MindTouch Deki v.8.08