site/properties (PUT)

Last updated
Save as PDF

Overview

Perform changes on multiple site properties

REST Method: PUT
Method Access: public

Query Parameters

Name	Type	Description
authenticate	bool?	Force authentication for request (default: false)
redirects	int?	If zero, do not follow page redirects.

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

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: site/properties/{key} instead. Properties are deleted if no contents node is provided. An etag is not required for deleting properties.

<properties>
 <property name="{text}" etag="{text}">
  <contents type="{text}">{text}</contents>  
  <change-description>{text}</change-description>
 </property>
 <property name="{text}"/>
</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

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.

C# Samples: Modify Site Properties

Authentication is performed and a site property is created named "myprop". Using the batch property update feature, "myprop" is updated with a new value with the current value's etag. A non existent property "propertyToDelete" is attempted to be deleted by not specifying a new content value.

Sample Code

Plug p = Plug.New("http://devwiki/@api/deki");
p.At("users", "authenticate").WithCredentials("sysop", "password").Get();

XDoc myPropResponse = p.At("site", "properties")  .WithHeader("Slug", "myprop")
 .Post(DreamMessage.Ok(MimeType.TEXT_UTF8, "initial value")).AsDocument();

XDoc body = new XDoc("properties");
body.Start("property").Attr("name", "myprop").Attr("etag", myPropResponse["/property/@etag"].AsText)
 .Start("contents").Attr("type", "text/plain").Value("new value for property").End()
 .Elem("description", "description of change")
 .End();
body.Start("property").Attr("name", "propertyToDelete").End();

XDoc response = p.At("site", "properties") .Put(body).AsDocument();

Sample Response from executing Code

<properties count="1" href="http://devwiki/@api/deki/site/properties">
  <property name="myprop" href="http://devwiki/@api/deki/site/properties/myprop/info" etag="4465.r2_ts2009-03-20T23:52:50Z">
    <contents type="text/plain" href="http://devwiki/@api/deki/site/properties/myprop">new value for property</contents>
    <date.modified>2009-03-20T23:52:50Z</date.modified>
    <user.modified id="1" href="http://devwiki/@api/deki/users/1">
      <nick>Sysop</nick>
      <username>Sysop</username>
    </user.modified>
    <change-description>description of change</change-description>
    <status code="200" />
  </property>
  <property name="propertyToDelete">
    <status code="400">
      <error>
        <status>400</status>
        <title>Bad Request</title>
        <message>The property 'propertyToDelete' does not exist and cannot be deleted.</message>
        <uri>http://devwiki/@api/deki/site/properties</uri>
      </error>
    </status>
  </property>
</properties>

Implementation notes

Add notes about requirements or config values.

Curl Sample: Modify Site Properties

The following command attaches site properties listed in "properties.xml".

Sample Code

curl -u admin:password -H "Content-Type: application/xml" -T properties.xml -i http://mindtouch.address/@api/deki/site/properties

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.
-H: Adds a header or modifies an existing one. In this case, since an xml document is being sent, the content type must be set to "application/xml". The server will not accept the request otherwise.
-T file: Specifies the .xml file that contains the user property data.
-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.

Example

Let's modify several site properties. The following XML document has a list of property elements which will modify the site properties. The property created here will be removed.

siteprop.xml

Content-Type: application/xml

<properties>

    <!-- Add a couple properties -->

    <property name="year">
	<contents type="text/plain">2010</contents>
    </property>
    <property name="whatsforlunch">
	<contents type="text/plain">Pizza</contents>
    </property>

    <!-- Remove a property, to do this omit contents element -->

    <property name="x"/>

</properties>

Command Line

curl -u admin:password -H "Content-Type: application/xml" -T siteprop.xml -i http://192.168.168.110/@api/deki/site/properties

HTTP Response Headers

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

HTTP Response Body

Content-Type: application/xml

<?xml version="1.0"?>
<properties count="3" href="http://192.168.168.110/@api/deki/site/properties">
  <property name="year" href="http://192.168.168.110/@api/deki/site/properties/year/info" etag="40.r1_ts2010-01-13T20:19:25Z">
    <contents type="text/plain" size="4" href="http://192.168.168.110/@api/deki/site/properties/year">2010</contents>
    <date.modified>2010-01-13T20:19:25Z</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>
    <status code="200"/>
  </property>
  <property name="whatsforlunch" href="http://192.168.168.110/@api/deki/site/properties/whatsforlunch/info" etag="41.r1_ts2010-01-13T20:19:26Z">
    <contents type="text/plain" size="5" href="http://192.168.168.110/@api/deki/site/properties/whatsforlunch">Pizza</contents>
    <date.modified>2010-01-13T20:19:26Z</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>
    <status code="200"/>
  </property>
  <property name="x" href="http://192.168.168.110/@api/deki/site/properties/x/info" etag="36.r2_ts2010-01-13T20:19:26Z">
    <contents type="text/plain" size="2" href="http://192.168.168.110/@api/deki/site/properties/x">10</contents>
    <date.modified>2010-01-13T20:19:26Z</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>
    <user.deleted 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.deleted>
    <date.deleted>2010-01-13T20:19:26Z</date.deleted>
    <status code="200"/>
  </property>
</properties>

Notes

To view all properties attached to the site, fetch the raw XML for it. In this case, the path is <http://192.168.168.110/@api/deki/site/properties>.