MindTouch Developer Center > MindTouch Deki > API Reference > GET:pages/{pageid}/files/{filename}/description

Overview

public. retrieves a file description

Uri Parameters
NameTypeDescription
filenamestring"=" followed by a double uri-encoded file name
pageidstringeither an integer page ID, "home", or "=" followed by a double uri-encoded page title
Query Parameters
NameTypeDescription
redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).
revisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
Return Codes
NameValueDescription
BadRequest400Invalid input parameter or request body
Forbidden403Read access to the page is required
NotFound404Requested file could not be found
Ok200The request completed successfully

Message Format

Output:
Content-type=text/plain

Implementation Notes

Use PUT:files/{fileid}/description to set the file description.

Code Samples

The following code example retrieves the description of the file called "myfile.jpg" on the home page:

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("pages", "home", "files", "=myfile%252ejpg", "description").Get();
String description = msg.AsText();
Tag page
You must login to post a comment.