Was this page helpful?

GET:archive/files

    Overview

    public. Retrieves file info for all deleted files

    Uri Parameters

    None

    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    Return Codes
    NameValueDescription
    Forbidden403Administrator access is required
    Ok200The request completed successfully

    Message Format

    Output:

    <files.archive>
        <file.archive 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>
            <user.deletedby id="{int}" href="{uri}">
                <nick>{text}</nick> 
                <username>{text}</username> 
                <email>{text}</email> 
            </user.deletedby>
            <date.deleted>{date}</date.deleted> 
            <page.parent id="{int}" href="{uri}">
                <title>{text}</title> 
                <path>{text}</path> 
            </page.parent>
        </file.archive>
        ...
    </files.archive>

    Implementation Notes

    When a file is deleted, it is moved into the archive. It will remain in the archive until it is either permanently deleted (DELETE:archive/files/{fileid}) or restored (POST:archive/files/restore/{fileid}).  While a file is in the archive, it cannot be modified.

    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