Page last modified 14:36, 26 Jan 2010 by melder
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > DELETE:pages/{pageid}
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. Deletes a page and optionally descendant pages by moving them to the archive
Uri Parameters
| Name | Type | Description |
| pageid | string | either an integer page ID, "home", or "=" followed by a double uri-encoded page title |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| recursive | bool? | only delete page or delete page and descendants. Default: false |
| redirects | int? | If zero, do not follow page redirects. |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Update/delete access to the page is required |
| NotFound | 404 | Requested page could not be found |
| Ok | 200 | Request completed successfully |
Message Format
Output:
<deletedpages count="{int}">
<page id="{int}" href="{uri}">
<title>{text}</title>
<path>{text}</path>
</page>
...
</deletedpages>
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.
If the recursive=true query parameter is specified, the page and all its descendants will be deleted. Otherwise, if the page has descendants, a placeholder parent page will be created for them.
Use GET:pages to retrieve a list of existing pages.
- 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