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

Overview

public. Retrieve list of sub-pages

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:

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

Implementation Notes

Redirect and archived pages are not included in the output.

Code Samples

The following code example retrieves the subpages for the home page:

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

Sample response indicating that there is one subpage:

<subpages href="http://deki-hayes/@api/deki/pages/29/subpages">
    <page.subpage id="31" href="http://deki-hayes/@api/deki/pages/31">
        <title>Page Title</title> 
        <path>Page_Title</path> 
    </page.subpage>
</subpages>
Tag page
You must login to post a comment.