GET:archive/pages

Overview

public. Retrieve the pages that can be potentially restored from deletion.

Uri Parameters

None

Query Parameters
NameTypeDescription
countstring?Number of titles to retrieve. 'ALL' for no limit. (default: 100)
offsetint?Number of titles to skip. Default: 0
titlestring?Show deleted pages matching the given title. (default: all pages)
Return Codes
NameValueDescription
Forbidden403Administrator access is required
Ok200The request completed successfully

Message Format

Output:

<pages.archive>
    <page.archive>
        <title>{text}</title> 
        <path>{text}</path> 
        <revisions.archive count="{int}" href="{uri}" /> 
    </page.archive>
    ...
</pages.archive>

Implementation Notes

When a page is deleted, the page and all files on it are moved into the archive. A page is never permanently deleted; it will remain in the archive until it is restored (POST:archive/pages/{pageid}/restore). While a page is in the archive, it cannot be modified.

Code Samples

The following code example retrieves a list of pages in the archive:

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("archive", "pages").Get();

Sample response indicating that there is one deleted page in the archive:

<pages.archive>
    <page.archive>
        <title>Page Title</title> 
        <path>Page_Title</path> 
        <revisions.archive count="2" href="http://deki-hayes/@api/deki/archive/pages/=Page_Title/revisions" /> 
    </page.archive>
</pages.archive>
Tag page
You must login to post a comment.
Powered by MindTouch Deki v.8.08