files/{fileid}/{filename} (GET)
Overview
Retrieve file attachment content
- REST Method: GET
- Method Access: public
Uri Parameters
| Name | Type | Description |
| fileid | int | identifies a file by ID |
| filename | string | Double uri-encoded file name. Should be prefixed with "=" if it does not have an extension. |
| pageid | string | either an integer page ID, "home", or "=" followed by a double uri-encoded page title |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| redirects | int? | If zero, do not follow page redirects (only applies when {pageid} is present). |
| includeDeleted | bool | When fileid is an integer ID, and this parameter is set to true, we will even return the file info if it was deleted at some point |
| revision | string? | 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 |
| format | {jpg, png, bmp, gif}? | Convert output to given type. Default is to use original type. |
| 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 |
| width | int? | Width of the image |
| height | int? | Height of the image |
Return Codes
| Name | Value | Description |
| OK | 200 | The request completed successfully |
| Bad Request | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Read access to the page is required |
| Not Found | 404 | Requested file could not be found |
| Not Implemented | 501 | Requested operation is not currently supported |
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.
Curl Code Sample:
This feature is identical to the one described here, but allows a user to append an arbitrary filename to the end of the path. The purpose of this is to extend file download support to some browsers that use the last value in the path as the downloaded file name.
Sample Code
If the user wants to download a file as "foo.abc"
curl -u username:password -i http://mindtouch.address/@api/deki/files/1/=foo.abc
Implementation notes
curl flags
- -u
- Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
- -i
- Outputs the HTTP response headers. Useful for debugging.
Response
- Note that a file, not an XML document, is returned. So if an image or any non-text file is requested, a bunch of junk will very possibly be returned to the console.
Files
- To view a list of all files, follow the instructions here.