Page last modified 21:07, 26 Jul 2010 by arnec
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > GET:archive/pages
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other Code Samples
Overview
public. Retrieve the pages that can be potentially restored from deletion.
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| limit | string? | Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100) |
| offset | int? | Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0) |
| title | string? | Show deleted pages matching the given title. (default: all pages) |
Return Codes
| Name | Value | Description |
| Forbidden | 403 | Administrator access is required |
| Ok | 200 | The 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
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by