Was this page helpful?

PUT:files/{fileid}/description

    Overview

    public. Update attachment description

    Uri Parameters
    NameTypeDescription
    fileidintidentifies a file by ID
    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Update access to the page is required
    NotFound404Requested file could not be found
    Ok200Request completed successfully

    Message Format

    Input:
    Content-type=text/plain

    Output:

    <file id="{int}" href="{uri}">
        <filename>{text}</filename> 
        <description>{text}</description> 
        <contents type="{mimetyp e}" size="{int}" width="{int}" height="{int}" href="{uri}" /> 
        <contents.preview rel="thumb" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
        <contents.preview rel="webview" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
        <date.created>{date}</date.created> 
        <user.createdby id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.createdby>
        <revisions count="{int}" href="{uri}" /> 
        <page.parent id="{int}" href="{uri}">
            <title>{text}</title> 
            <path>{text}</path> 
        </page.parent>
    </file>

    Implementation Notes

    Use GET:files/{fileid}/description to retrieve the file description.

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by