Page last modified 00:11, 19 Mar 2009 by MaxM
MindTouch Community Portal > Deki - English > API Reference > GET:pages/{pageid}/files/{filename}/revisions
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 revision info
Uri Parameters
| Name | Type | Description |
| filename | string | "=" followed by a double uri-encoded file name |
| 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) |
| changefilter | string? | Only show revisions having a user-action listed in this comma delimited list. Valid actions are: CONTENT, NAME, LANGUAGE, META, DELETEFLAG, PARENT (default: all actions) |
| redirects | int? | If zero, do not follow page redirects (only applies when {pageid} is present). |
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 |
| Ok | 200 | The request completed successfully |
Message Format
Output:
<files count="{int}">
<file id="{int}" revision="{int}" href="{uri}">
<filename>{text}</filename>
<description>{text}</description>
<contents type="{mimetype}" size="{int}" width="{int}" height="{int}" href="{uri}" />
<contents.preview rel="thumb" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" revision="{int}" />
<contents.preview rel="webview" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" revision="{int}" />
<date.created>{date}</date.created>
<user.createdby id="{int}" href="{uri}">
<nick>{text}</nick>
<username>{text}</username>
<email>{text}</email>
</user.createdby>
</file>
...
</files>
Implementation Notes
A new file revision is created whenever a file with the same name is uploaded to the same page. Use GET:files/{fileid} with the revision parameter to retrieve the file from a specified revision.
The contents.preview element only exists if a file preview is available. Preview generation requires the file to be an image and fall within a certain size.
Code Samples
The following code example retrieves revision information about the file with ID 456:
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("pages", "home", "files", "=myfile%252ejpg", "revisions").Get();
Sample response indicating that there are two file revisions:
<files count="2">
<file id="456" revision="1" href="http://deki-hayes/@api/deki/files/456/info?revision=1">
<filename>myfile.jpg</filename>
<description/>
<contents type="image/pjpeg" size="53112" width="476" height="480" href="http://deki-hayes/@api/deki/files/456?revision=1" />
<contents.preview rel="thumb" type="image/pjpeg" maxwidth="160" maxheight="160" href="http://deki-hayes/@api/deki/files/456?revision=1&size=thumb" revision="1" />
<contents.preview rel="webview" type="image/pjpeg" maxwidth="550" maxheight="550" href="http://deki-hayes/@api/deki/files/456?revision=1&size=webview" revision="1" />
<date.created>2007-08-25T00:11:01Z</date.created>
<user.createdby id="1" href="http://deki-hayes/@api/deki/users/1">
<nick>Admin</nick>
<username>Admin</username>
<email>admin@mindtouch.com</email>
</user.createdby>
</file>
<file id="456" revision="2" href="http://deki-hayes/@api/deki/files/456/info?revision=2">
<filename>myfile.jpg</filename>
<description />
<contents type="image/pjpeg" size="53112" width="476" height="480" href="http://deki-hayes/@api/deki/files/456?revision=2" />
<contents.preview rel="thumb" type="image/pjpeg" maxwidth="160" maxheight="160" href="http://deki-hayes/@api/deki/files/456?revision=2&size=thumb" revision="2" />
<contents.preview rel="webview" type="image/pjpeg" maxwidth="550" maxheight="550" href="http://deki-hayes/@api/deki/files/456?revision=2&size=webview" revision="2" />
<date.created>2007-08-27T19:59:24Z</date.created>
<user.createdby id="1" href="http://deki-hayes/@api/deki/users/1">
<nick>Admin</nick>
<username>Admin</username>
<email>admin@mindtouch.com</email>
</user.createdby>
</file>
</files>
- Tag page
- What links here
Images 0
You must login to post a comment.