Page last modified 00:10, 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. Retrieves file content for a deleted file
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) |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Administrator access is required |
| NotFound | 404 | Requested file could not be found in the archive |
| Ok | 200 | The request completed successfully |
Message Format
None
Implementation Notes
When a file is deleted, it is moved into the archive. It will remain in the archive until it is either permanently deleted (DELETE:archive/files/{fileid}) or restored (POST:archive/files/restore/{fileid}). While a file is in the archive, it cannot be modified.
The Content-Disposition, Content-Length, and Content-Type headers provide information about the retrieved file.
Code Samples
The following code example retrieves the archived file with ID 456 and saves it in the caller's temporary directory:
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("archive", "files", "456").Get();
using (FileStream fs = System.IO.File.OpenWrite(Path.GetTempPath() + msg.ContentDisposition.FileName))
{
byte[] fileData = msg.AsBytes();
fs.Write(fileData, 0, fileData.Length);
}
- Tag page
- What links here
Images 0
You must login to post a comment.