Was this page helpful?

GET:pages/{pageid}

    Overview

    public. Retrieve aggregate page information including attachments

    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> 
        <metrics>
            <metric.views>{int}</metric.views> 
            <metric.charcount>{int}</metric.charcount> 
        </metrics>
        <summary>{text}</summary> 
        <security href="{uri}">  
            <permissions.effective>  
                <operations mask="{int}">{text}</operations>   
            </permissions.effective>  
            <permissions.page>  
                <operations mask="{int}">{text}</operations>   
                <restriction>{text}</restriction>   
            </permissions.page>  
            <grants>  
                <grant>  
                    <permissions>  
                        <operations mask="{int}">{text}</operations>   
                        <role id="{int}" href="{uri}">{text}</role>   
                    </permissions>  
                    <user id="{int}" href="{uri}">  
                        <nick>{text}</nick>   
                        <username>{text}</username>   
                        <email>{text}</email>   
                    </user>  
                    <date.expires>{date}</date.expires>
                    <date.modified>{date}</date.modified>   
                    <user.modifiedby id="{int}" href="{uri}">  
                        <nick>{text}</nick>   
                        <username>{text}</username>   
                        <email>{text}</email>   
                    </user.modifiedby>  
                </grant>  
                <grant>  
                    <permissions>  
                        <operations mask="{int}">{text}</operations>   
                        <role id="{int}" href="{uri}">{text}</role>   
                    </permissions>  
                    <group id="{int}" href="{uri}">  
                        <name>{text}</name>   
                    </group>  
                    <date.expires>{date}</date.expires>
                    <date.modified>{date}</date.modified>   
                    <user.modifiedby id="{int}" href="{uri}">  
                        <nick>{text}</nick>   
                        <username>{text}</username>   
                        <email>{text}</email>   
                    </user.modifiedby>  
                </grant>  
                ...  
            </grants>  
        </security> 
        <date.edited>{date}</date.edited> 
        <date.modified>{date}</date.modified> 
        <user.author id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.author>
        <description>{text}</description> 
        <page.redirectedfrom>
            <page id="{int}" href="{uri}">
                <title>{text}</title> 
                <path>{text}</path> 
            </page>
        </page.redirectedfrom> 
        <subpages href="{uri}" /> 
        <outbound count="{int}">
            <page id="{int}" href="{uri}">
                <title>{text}</title> 
                <path>{text}</path> 
            </page>
            ...
        </outbound>
        <inbound count="{int}">
            <page id="{int}" href="{uri}">
                <title>{text}</title> 
                <path>{text}</path> 
            </page>
            ...
        </inbound> 
        <aliases href="{uri}" /> 
        <revisions count="{int}" href="{uri}" /> 
        <revisions.archive count="{int}" href="{uri}" /> 
        <comments count="{int}" href="{uri}" /> 
        <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>
        <contents type="application/x.deki0702+xml" href="{uri}" /> 
    </page>

    Implementation Notes

    This feature is useful when a variety of information is required about the page. If only one type of information is needed, such as files or page security settings, it is more efficient to call the feature specifically designed for this purpose.

    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