Update forums
To update a stand-alone forum, send an updated forum document in Atom format to the existing forum's edit web address.All existing forum entry metadata will be replaced with the new data. To avoid deleting all existing data, retrieve any data you want to retain first, and send it back with this request. See Retrieve forums for more information.
See Authenticating requests for information about how to authenticate the request.
Table 1. Atom API request details
Method Resource URI Input representation PUT forum
- Web address returned in the HTTP location header when the forum was created.
- Web address of the href attribute of the <link> element with the rel="edit" attribute of a forum Atom entry.
forum
Input
Provide a forum Atom entry document.Note: The content type of the Atom entry document must be application/atom+xml.
If you want to lock the forum, add the element <category scheme="http://www.ibm.com/xmlns/prod/sn/flags" term="locked"/> in the forum entry that you pass in as input. If you want to unlock a forum, remove the same element from the forum entry that you pass in as input.
Output
None.Returned HTTP headers
HTTP/1.1 200 OK
Indicates that the forum was successfully updated. If an error occurs, this header contains one of the error codes.
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 404 Not Found
Request:
PUT /forums/atom/forum?forumUuid=3b153694-e27e-4085-8868-2952110fdad2 HTTP/1.1 Host: www.dulcinea.com Content-Type: application/atom+xml Authorization: xxx Content-Length: nnn <?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns:snx="http://www.ibm.com/xmlns/prod/sn" xmlns:thr="http://purl.org/syndication/thread/1.0"> <id>urn:lsid:ibm.com:forum:3b153694-e27e-4085-8868-2952110fdad2</id> <title type="text">CKEditor</title> <published>2010-08-04T15:13:29.746Z</published> <updated>2010-08-04T18:06:59.481Z</updated> <author> <email>jdoe@literature.com</email> <name>Jane Doe</name> <snx:userid>F1449510-CF43-D282-8525-7346003DAD9D</snx:userid> <snx:userState>active</snx:userState> </author> <contributor> <email>ajones9@janet.iris.com</email> <name>Amy Jones9</name> <snx:userid>4C259C9C-9F1C-85B0-8525-7346003DB02A</snx:userid> <snx:userState>active</snx:userState> </contributor> <link href="http://www.dulcinea.com/forums/atom/entries?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="self" type="application/atom+xml"> </link> <link href="http://www.dulcinea.com/forums/atom/forum?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="edit" type="application/atom+xml"> </link> <category term="forum-forum" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category> <category term="ckeditor"></category> <link href="http://www.dulcinea.com/forums/html/forum?id=3b153694-e27e-4085-8868-2952110fdad2" rel="alternate" type="text/html"> </link> <link href="http://www.dulcinea.com/forums/atom/topics?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="replies" type="application/atom+xml" thr:count="0"> </link> <link href="http://www.dulcinea.com/forums/atom/service?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="service" type="application/atomsvc+xml" title="Atom Publishing Protocol"> </link> <thr:in-reply-to href="http://www.dulcinea.com/forums/atom/forums" ref="http://www.dulcinea.com/forums/atom/forums" type="application/atom+xml"> </thr:in-reply-to> <content type="html">Read a great short story yesterday.</content> </entry>Response:
HTTP/1.1 200 OK
Parent topic
Work with stand-alone forums
});