pages/{pageid}/files/{filename} (HEAD)
Overview
Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)
- REST Method: HEAD
- 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 |
Implementation Notes
The Content-Length, and Content-Type headers provide information about the retrieved file.
Code Samples
The following code example retrieves the headers for the file called "myfile.jpg" on the home page:
Plug p = Plug.New("http://example.mindtouch.us/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("pages", "home", "files", "=myfile%252ejpg").Invoke("HEAD", DreamMessage.Ok()); Sample output:
Connection=close Content-Length=110326 Content-Type=image/jpeg Date=Wed, 14 May 2008 22:31:30 GMT Server=Dream-HTTPAPI/1.5.2.25231 Microsoft-HTTPAPI/1.0 Via=1.0 example.mindtouch.us