site/properties/{key} (PUT)

Last updated
Save as PDF

Overview

Update an existing site property

REST Method: PUT
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
authenticate	bool?	Force authentication for request (default: false)
abort	{never, modified, exists}?	Specifies condition under which to prevent the update; default is modified.
redirects	int?	If zero, do not follow page redirects.
etag	string?	Etag of the current version of the property. Can alternatively be provided via ETag header.
description	string?	Description of property

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 right is required to read, create, or change a site property's value.

C# Sample: Modify a Site Property

The following code authenticates and modifies a site property named 'foo' with a text value. A description of the change is set as well.

Sample Code

Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
p.At("site", "properties", "foo") .WithHeader(DreamHeaders.ETAG, "4463.r1_ts2009-03-19T20:00:15Z")
 .With("description", "correcting the value") 
 .Put(DreamMessage.Ok(MimeType.TEXT_UTF8, "My Value"));

Sample Response from executing Code

<property name="foo" href="http://devwiki/@api/deki/site/properties/foo/info" etag="4463.r2_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>correcting the value</change-description>
</property>

Implementation notes

Add notes about requirements or config values.

Curl Sample: Modify a Site Property

The following command modifies site property "foo" and pairs the file "bar" to the property.

Sample Code

curl -u admin:password -H "Content-Type: text/plain" -H "Etag: xxx" -T bar -i http://mindtouch.address/@api/deki/site/properties/foo

Implementation notes

curl flags

-u

Basic HTTP authentication. Sends a username and password to server so it can verify whether a user is of privilege to perform specific operation.
-T file: Specifies a PUT request and the file to send.
-H: Replaces or appends an HTTP header. The "Content-Type" header specifies the MIME type of the value attached to the property.
-i: Includes the HTTP response header in the output. Useful for debugging.

Permissions

ADMIN permission is required to execute above command. Otherwise, a 403 HTTP response (Forbidden) will be returned.

MIMEs

Properties can contain any type of file, therefore it is important to specify the correct MIME when creating a property. For instance, a text property will require a text/plain header, xml will require application/xml header, a jpeg image will require image/jpg header, and so on.

ETag

An ETag is required to ensure the property being modified is in its most recent revision. If there is an ETag mismatch, the server will return a 409 HTTP response (Conflict). There are two ways to pass ETags to the server. The first, adding an ETag HTTP header, is shown above. ETags can also be passed via appending a parameter to the end of the path. The following is equivalent to the above sample:

curl -u admin:password -H "Content-Type: text/plain" -T bar -i http://mindtouch.address/@api/deki/site/properties/foo?etag=xxx

Example

We want to change a site property "whatsforlunch" from "Pizza" to "Hamburgers". The property was created here.

lunchsiteprop.txt

Content-Type: text/plain

Hamburgers

Sample Code

curl -u admin:password -H "Content-Type: text/plain" -H "Etag: 41.r1_ts2010-01-13T20:19:26Z" -T lunchsiteprop.txt -i http://192.168.168.110/@api/deki/site/properties/whatsforlunch

HTTP Response Headers

HTTP/1.1 200 OK
Date: Wed, 13 Jan 2010 21:13:23 GMT
Server: Dream-HTTPAPI/1.7.2.17433
X-Deki-Site: id="default"
Content-Type: application/xml; charset=utf-8
Content-Length: 688
Via: 1.1 dekiwiki

HTTP Response Body

Content-Type: application/xml

<?xml version="1.0"?>
<property name="whatsforlunch" href="http://192.168.168.110/@api/deki/site/properties/whatsforlunch/info" etag="41.r2_ts2010-01-13T21:13:23Z">
  <contents type="text/plain" size="10" href="http://192.168.168.110/@api/deki/site/properties/whatsforlunch">Hamburgers</contents>
  <date.modified>2010-01-13T21:13:23Z</date.modified>
  <user.modified id="1" href="http://192.168.168.110/@api/deki/users/1">
    <nick>Admin</nick>
    <username>Admin</username>
    <email>melder@mindtouch.com</email>
    <hash.email>637b79dca5c8ebdc4347bccca42d3487</hash.email>
    <uri.gravatar>http://www.gravatar.com/avatar/637b79dca5c8ebdc4347bccca42d3487</uri.gravatar>
  </user.modified>
  <change-description/>
</property>

Notes

To view the list of properties attached to the site, view the site properties raw XML data. For example, for the above path, the XML data would be located here <http://192.168.168.110/@api/deki/site/properties>.