pages/{pageid}/properties/{key}/info (GET)

Overview

Retrieve the metadata about a page property

REST Method: GET
Method Access: public

NOTE: Expert sets a limit of 1,000 properties per page.

Uri Parameters

Name	Type	Description
key	string	A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
pageid	string	either an integer page ID, "home", or "=" followed by a double uri-encoded page path

Query Parameters

Name	Type	Description
authenticate	bool?	Force authentication for request (default: false)
redirects	int?	If zero, do not follow page redirects.
contentcutoff	int?	Only show property content shorter than this number of bytes. Default: 2048

Return Codes

Name	Value	Description
OK	200	The request completed successfully
Bad Request	400	Invalid input parameter or request body
Forbidden	403	READ access is required
Not Found	404	Requested page and/or property could not be found

Message Format

Response is the standard property XML

<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>

Implementation Notes

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.
READ access to the page is required to see page properties

C# Code Sample: Retrieve Info about a Page Property

The following code authenticates and retrieves information about a page property named 'foo' .

Sample Code


Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
XDoc ret = p.At("pages", "=My%252fTest%252fPage", "properties", "foo", "info")
 .Get().AsDocument();

Sample Response from executing Code

<property name="foo" href="http://devwiki/@api/deki/pages/42/properties/foo/info" etag="4463.r1_ts2009-03-20T22:48:15Z">
  <contents type="text/plain; charset=utf-8" href="http://devwiki/@api/deki/pages/42/properties/foo">My Value</contents>
  <date.modified>2009-03-20T22:48:15Z</date.modified>
  <user.modified id="1" href="http://devwiki/@api/deki/users/1">
    <nick>Sysop</nick>
    <username>Sysop</username>
  </user.modified>
  <change-description>initial value</change-description>
</property>

Implementation notes

Add notes about requirements or config values

Curl Code Sample: Retrieve Info about a Page Property

The following command retrieves metadata of page property "foo" associated with page "bar":

Sample Code

curl -u username:password -i http://mindtouch.address/@api/deki/pages/=bar/properties/foo/info

Sample Response from executing Code

Example metadata of the page property listed here.

Content-Type: application/xml

<property name="urn:custom.mindtouch.com#test" href="http://192.168.59.128/@api/deki/pages/567/properties/urn%253acustom.mindtouch.com%2523test/info" etag="114.r1_ts2010-01-29T22:16:57Z">
  <contents type="text/plain; charset=utf-8" size="4" href="http://192.168.59.128/@api/deki/pages/567/properties/urn%253acustom.mindtouch.com%2523test">test</contents>
  <date.modified>2010-01-29T22:16:57Z</date.modified>
  <user.modified id="88" href="http://192.168.59.128/@api/deki/users/88">
    <nick>test6</nick>
    <username>test6</username>
    <email hidden="true"/>
    <hash.email>989d7c3b24422e0f2ab2da41e3a91434</hash.email>
    <uri.gravatar>http://www.gravatar.com/avatar/989d7c3b24422e0f2ab2da41e3a91434</uri.gravatar>
  </user.modified>
</property>

Implementation notes

curl flags

-u: Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
-i: Outputs the HTTP response headers. Useful for debugging.

Page properties

To view a list of all properties for a given page, follow the instructions here.