Was this page helpful?

GET:pages/{pageid}/files,subpages

    Overview

    public. Retrieves a list of files and subpages for a given page

    Uri Parameters
    NameTypeDescription
    pageidstringeither an integer page ID, "home", or "=" followed by a double uri-encoded page title
    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    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:

    <page id="{int}" href="{uri}">
        <title>{text}</title> 
        <path>{text}</path> 
        <subpages href="{uri}">
            <page.subpage id="{int}" href="{uri}">
                <title>{text}</title> 
                <path>{text}</path> 
            </page.subpage>
            ... 
        </subpages>
        <files count="{int}">
            <file id="{int}" href="{uri}">
                <filename>{text}</filename> 
                <description>{text}</description> 
                <contents type="mimetype" size="{int}" width="{int}" height="{int}" href="{uri}" /> 
                <contents.preview rel="thumb" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
                <contents.preview rel="webview" type="{mimetype}" maxwidth="{int}" maxheight="{int}" href="{uri}" /> 
                <date.created>{date}</date.created> 
                <user.createdby id="{int}" href="{uri}">
                    <nick>{text}</nick> 
                    <username>{text}</username> 
                    <email>{text}</email> 
                </user.createdby>
                <revisions count="{int}" href="{uri}" /> 
            </file>
            ...
        </files>
    </page>

    Implementation Notes

    The contents.preview element only exists if a file preview is available. Preview generation requires the file to be an image and fall within a certain size.

    Files and pages in the archive are not included in the output.

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by