Was this page helpful?

PUT:pages/{pageid}/files/{filename}

    Overview

    public. Replace an existing attachment with a new version or create a new attachment

    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
    authenticatebool?Force authentication for request (default: false)
    descriptionstring?file attachment description
    redirectsint?If zero, do not follow page redirects.
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Update access to the page is required
    NotFound404Requested page could not be found
    Ok200The request completed successfully

    Message Format

    Input:
    File to upload

    Output:

    <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>
        <page.parent id="{int}" href="{uri}">
            <title>{text}</title> 
            <path>{text}</path> 
        </page.parent>
    </file>

    Implementation Notes

    File uploads to template pages are not allowed. 

    If a file with the same name already exists on the specified page, a new revision of the existing file is uploaded.  Otherwise, a new file is created.

    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

    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