Page last modified 13:56, 28 Jan 2010 by melder
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > GET:pages/{pageid}/diff
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. Show changes between revisions
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) |
| diff | {combined, all}? | Result format; 'combined' shows changes to the page contents, 'all' shows in addition the before and after versions of the page with highlighted changes; default is 'combined' |
| format | {html, xhtml}? | Result format (default: html) |
| mode | {edit, raw, view}? | which rendering mode to use when diffing; default is 'edit' |
| previous | string? | Previous page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer will retrieve specific revision |
| redirects | int? | If zero, do not follow page redirects. |
| revision | string? | Page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer will retrieve specific revision |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Read access to the page is required |
| NotFound | 404 | Requested page could not be found |
| Ok | 200 | The request completed successfully |
Message Format
Output:
<content type="{contenttype}">{text}</content>
Implementation Notes
Setting Previous/Revision=1 refers to the earliest revision, 2 refers to
the next earliest revision, and so on. Similarly, Previous/Revision=-1
refers to the revision prior to the current, -2 refers to the
revision two prior to the current, and so on.
This feature uses the ViewNoExecute mode output from GET:pages/{pageid}/contents to perform the diff comparison.
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