MindTouch Developer Center > MindTouch Deki > API Reference > GET:pages/{pageid}/aliases

GET:pages/{pageid}/aliases

Overview

public. Retrieve list of page aliases

Uri Parameters
NameTypeDescription
pageidstringeither an integer page ID, "home", or "=" followed by a double uri-encoded page title
Query Parameters
NameTypeDescription
redirectsint?If zero, do not follow page redirects.
Return Codes
NameValueDescription
BadRequest400Invalid input parameter or request body
Forbidden403Read access to the page is required
NotFound404Requested page could not be found
Ok200The request completed successfully

Message Format

Output:

<aliases count="{int}" href="{uri}">
    <page id="{int}" href="{uri}">
        <title>{text}</title> 
        <path>{text}</path> 
    </page>
    ...
</aliases>

Implementation Notes

An alias is a page that redirects to a given page. The system automatically creates an alias when a page is moved or renamed.

Code Samples

The following code example retrieves the aliases for the page "Page Title":

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

Sample response indicating that the page "Page Title 1" is an alias to "Page Title":

<aliases count="1" href="http://deki-hayes/@api/deki/pages/202/aliases">
    <page id="207" href="http://deki-hayes/@api/deki/pages/207">
        <title>Page Title 1</title> 
        <path>Page_Title_1</path> 
    </page>
</aliases>
Tag page
You must login to post a comment.
Powered by MindTouch Deki v.8.08