pages/{pageid}/properties/{key} (DELETE)

Overview

Remove a page property

REST Method: DELETE
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.

Return Codes

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

Implementation Notes

UPDATE rights on the page is necessary to delete a property.
A current eTag is not required for deleting a property

C#Code Sample: Delete Page Property

The following code authenticates and deletes a page property named 'foo'.

Sample Code


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

Implementation notes

Add notes about requirements or config values

Curl Code Sample: Delete a Page Property

The following command deletes page property "foo" from page "bar":

Sample Code

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

Implementation notes

curl flags

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