Was this page helpful?

GET:files

    Overview

    public. Retrieve information for all attached files

    Uri Parameters

    None

    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    numfilesint?Number of files to retrieve. 'ALL' for no limit. Default: 100
    skipint?Number of files to skip. Default: 0
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Read access to the page sis required
    Ok200The request completed successfully

    Message Format

    Output:

    <files count="{int}">
        <file id="{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}" /> 
            <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}" /> 
        </file>
        ...
    </files>

    Implementation Notes

    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.

    Files in the archive are not included in the output.

    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