site/properties/{key}/info (GET)

Last updated
Save as PDF

Overview

Retrieve the metadata about a site property

REST Method: GET
Method Access: public

Uri Parameters

Name	Type	Description
key	string	A unique identifier for a property that is obtained through GET:site/properties

Query Parameters

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

Return Codes

Name	Value	Description
OK	200	The request completed successfully
Bad Request	400	Invalid input parameter or request body
Forbidden	403	ADMIN access is required
Not Found	404	Requested 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.
ADMIN access is required to see site properties

C# Code Sample: Retrieve Site Property Metadata

The following code authenticates and retrieves information about a site 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("site", "properties", "foo", "info")
 .Get().AsDocument();

Sample Response from executing Code

<property name="foo" href="http://devwiki/@api/deki/site/properties/foo/info" etag="4463.r1_ts2009-03-20T22:48:15Z">
  <contents type="text/plain; charset=utf-8" href="http://devwiki/@api/deki/site/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>

Curl Code Sample: Retrieve Site Property Metadata

The following command fetches information about site property "foo":

Sample Code

curl -u admin:password -i http://mindtouch.address/@api/deki/properties/foo/info

Sample Response from executing Code

Example output of retrieving the metadata of site property listed here.

Content-Type: application/xml

<property name="foo" href="http://192.168.59.128/@api/deki/site/properties/foo/info" etag="115.r1_ts2010-02-01T23:49:47Z">
  <contents type="text/plain" size="3" href="http://192.168.59.128/@api/deki/site/properties/foo">bar</contents>
  <date.modified>2010-02-01T23:49:47Z</date.modified>
  <user.modified id="1" href="http://192.168.59.128/@api/deki/users/1">
    <nick>Admin</nick>
    <username>Admin</username>
    <email>admin@admin.com</email>
    <hash.email>64e1b8d34f425d19e1ee2ea7236d3028</hash.email>
    <uri.gravatar>http://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028</uri.gravatar>
  </user.modified>
  <change-description/>
</property>

Implementation notes

curl flags

-u: Provides external user authentication.
-i: Outputs the HTTP response headers. Useful for debugging.

Permissions

ADMIN permission is required to execute above command.

Site properties

To view a list of all site properties, follow the instructions here.