Page last modified 00:11, 19 Mar 2009 by MaxM
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
Overview
public. Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)
Uri Parameters
| Name | Type | Description |
| fileid | int | identifies a file by ID |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| format | {jpg, png, bmp, gif}? | Convert output to given type. Default is to use original type. |
| height | int? | 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 |
| redirects | int? | If zero, do not follow page redirects (only applies when {pageid} is present). |
| 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 |
| width | int? | Width of the image |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Read access to the page is required |
| NotFound | 404 | Requested file could not be found |
| NotImplemented | 501 | Requested operation is not currently supported |
| Ok | 200 | The request completed successfully |
Message Format
None
Implementation Notes
The Content-Length and Content-Type headers provide information about the retrieved file.
Use GET:files to retrieve a list of files across the site or GET:pages/{pageid}/files to retrieve the files on a specified page.
Code Samples
The following code example retrieves the headers for the file with ID 456:
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("files", "456").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 deki-hayes
- Tag page
- What links here
Images 0
You must login to post a comment.