Overview
Explain how contents of a page are rendered.
- REST Method: GET
- Method Access: public
Uri Parameters
| Name |
Type |
Description |
| pageid |
string |
either an integer page ID, "home", or "=" followed by a double uri-encoded page path |
Query Parameters
| Name |
Type |
Description |
| overview |
bool? |
Include the overview section. (default: false) |
| include |
bool? |
Treat page as an include (default: false) |
| reltopath |
string? |
Page used for path normalization. Ignored if relto parameter is defined. (default: none) |
| relto |
int? |
Page used for path normalization (default: none) |
| authenticate |
bool? |
Force authentication for request (default: false) |
| pageid |
int? |
For template pages, use specified page ID as context for template invocation (default: none) |
| includes |
string? |
Comma separated list of extra elements to include (choice of "overview", "tags". default: include nothing extra) |
| format |
{html, xhtml, text, dekicode}? |
Result format. Text only valid in mode=view if the page was authored by someone with unsafecontent permission (default: html) |
| highlight |
string? |
Comma separated list of terms to highlight (default: empty) |
| revision |
string? |
Page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer or a TimeUUID will retrieve specific revision |
| mode |
{edit, raw, view} |
render content for different uses; default is 'view' |
| redirects |
int? |
If zero, do not follow page redirects. |
| section |
int? |
The section number (default: none) |
Return Codes
| Name |
Value |
Description |
| OK |
200 |
The request completed successfully |
| Non-Authoritative Information |
203 |
Page contents could not be parsed in its native format and was returned in an alternative format instead |
| Bad Request |
400 |
Invalid input parameter or request body |
| Forbidden |
403 |
Update access to the page is required |
| Not Found |
404 |
Requested page could not be found |
