Was this page helpful?

PUT:pages/{pageid}/properties

    Overview

    public. Perform changes on multiple page properties

    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
    Forbidden403UPDATE access is required
    NotFound404Requested page could not be found
    Ok200The request completed successfully

    Message Format

    Input is a list of property xml blocks. Only text values are allowed to be modified via this feature. To modify a non-text property value, use PUT: pages/{pageid}/properties/{key} instead. Properties are deleted if no contents node is provided. An etag is not required for deleting properties. Note that the language element is accepted for backwards compatibility.

    <properties>
     <property name="{text}" etag="{text}">
      <contents type="{text}">{text}</contents>  
      <change-description>{text}</change-description>
     </property>
     <property name="{text}"/>
     <language>{language}</language>
    </properties>

    Response is a list of the standard property xml blocks as well as any error blocks.

    <properties count="{int}" href="{uri}">
     <property name="{text}" href="{uri}" etag="{text}">
      <contents type="{text}" href="{uri}">{text}</contents>
      <date.modified>{date}</date.modified>
      <user.modified id="{int}" href="{uri}">
        <nick>{text}</nick>
        <username>{text}</username>
      </user.modified>
      <change-description>{text}</change-description>
     </property>
     <property name="{text}">
        <status code="{int}">
          <error>
            <status>{int}</status>
            <title>{text}</title>
            <message>{text}</message>
            <uri>{uri}</uri>
          </error>
        </status>
     </property>
    </properties>

    Implementation Notes

    • This feature supports modifying the page language with the 'language' element. It must be a valid language code such as "en", "de", "zh-tw" etc.  An empty language indicates culture invariant.
    • The response XML will contain the contents text only for text based mimetypes with values less than 2048 chars in length. Otherwise the contents is available at the URI pointed to by property/contents/@href.

    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