Create a stand-alone forum topic programmatically 

To add a topic to a stand-alone forum, send an Atom entry document containing the forum topic to the forum topics resource.

See Authenticating requests for information about how to authenticate the request.

Table 1. Atom API request details

Method Resource URI Input representation
POST forum topics Value of the href attribute of the <link> element with the rel="replies" attribute value for each forum. forum topic


Input

Provide a forum topic Atom entry document.

Note: The content type of the Atom entry document must be application/atom+xml.

If you want to create a question instead of a normal topic, add the <category term="question" scheme="http://www.ibm.com/xmlns/prod/sn/flags"/> element to the topic entry document that you pass in on the request.

To create a topic with an attachment, use a multipart post by completing the following steps:

  1. Send a POST request with the following content-type header:

      Content-Type: multipart/related;type="application/atom+xml"

  2. Pass the topic entry as input on the request first, and then specify the attachments. For example:

      <entry xmlns="http://www.w3.org/2005/Atom">     
        <title type="text">RE:Where do the log files go?</title>     
        <category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="forum-reply" />     
        <thr:in-reply-to 
         ref="urn:lsid:ibm.com:forum:2E8G091E0E92B0EA6D6B07051CEE7F00007C" 
         type="application/atom+xml"     
         href="http://www.dulcinea.com/forum/service/atom/replies?topicUuid=2E8G091E0E92B0EA6D6B07051CEE7F00007C"/>     
        <content type="text">
         The log files cannot reside in the specified directory because they are too large.
        </content> 
      </entry>   
      --MIME_boundary   
      Content-Type: image/jpg   
      Content-ID: <image file id of image1.jpg>   
      Content-Length: nnnn   
      Slug: image1  (binary data of image1 file)

Output

An Atom entry document containing the new forum topic.

Note: If there are attachments in the topic entry, the metadata for the attachment will be added to the entry. For example:

<snx:field name="forum_design_images" fid="4b59fea6-2810-42ef-ae4a-37334674e138" type="file">
  <link 
   type="image/jpg" 
   href="http://www.dulcinea.com/forums/atom/download?nodeId=4b59fea6-2810-42ef-ae4a-37334674e138" length="2020" />
 </snx:field>

Returned HTTP headers

HTTP/1.1 201 Created

Location: url

Error codes

Request:

POST /forums/atom/topics?forumUuid=e1b8faff-afc7-4ba8-9269-05bfd592efc7 HTTP/1.1
Host: www.dulcinea.com
Content-Type: application/atom+xml
Authorization: xxx
Content-Length: nnn
 
<entry xmlns="http://www.w3.org/2005/Atom">
    <title type="text">Test topic 1</title>
    <content type="text">topic test</content>
    <updated>2010-08-04T13:48:41.700Z</updated>
    <category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="forum-topic"></category>
    <category term="aa"></category>
    <category term="bb"></category>
</entry>

Response:

HTTP/1.1 201 Created
Date: Wed, 04 Aug 2010 21:45:09 GMT
Content-Length: nnn
Content-Type: application/atom+xml; charset="utf-8"
Location: http://www.dulcinea.com/forums/atom/topics
 
<entry xmlns="http://www.w3.org/2005/Atom">
    <id>urn:lsid:ibm.com:forum:84139b22-17f0-4290-939b-73370c6ef17c</id>
    <title type="text">Test topic 1</title>
    <published>2010-08-04T21:45:09.324Z</published>
    <updated>2010-08-04T21:45:09.324Z</updated>
    <author>
        <email>jdoe@literature.com</email>
        <name>Jane Doe</name>
        <snx:userid 
         xmlns:snx="http://www.ibm.com/xmlns/prod/sn">772A006E-0A01-8703-8525-7346003DAFD6
        </snx:userid>
        <snx:userState xmlns:snx="http://www.ibm.com/xmlns/prod/sn">active</snx:userState>
    </author>
    <link 
     href="https://www.dulcinea.com/forums/atom/topic?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="self" 
     type="application/atom+xml">
    </link>
    <link 
     href="https://www.dulcinea.com/forums/atom/topic?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="edit" 
     type="application/atom+xml">
    </link>
    <category term="forum-topic" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category>
    <category term="bb"></category>
    <category term="aa"></category>
    <link 
     href="https://www.dulcinea.com/forums/html/topic?id=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="alternate" 
     type="text/html">
    </link>
    <link 
     xmlns:thr="http://purl.org/syndication/thread/1.0" 
     href="https://www.dulcinea.com/forums/atom/replies?topicUuid=84139b22-17f0-4290-939b-73370c6ef17c" 
     rel="replies" 
     type="application/atom+xml" 
     thr:count="0">
    </link>
    <thr:in-reply-to 
     xmlns:thr="http://purl.org/syndication/thread/1.0" 
     href="https://www.dulcinea.com/forums/atom/topics?forumUuid=e1b8faff-afc7-4ba8-9269-05bfd592efc7" 
     ref="urn:lsid:ibm.com:forum:e1b8faff-afc7-4ba8-9269-05bfd592efc7" 
     type="application/atom+xml">
    </thr:in-reply-to>
    <content type="html">topic test</content>
    <snx:permissions xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
      none, create_forum, view_forum, edit_forum, del_forum, create_post, edit_personal_post, edit_all_post,
      del_personal_post, del_all_post, pin_topic, subscribe, lock_node, add_member, delete_member, 
      create_topictag, del_all_topictag, del_personal_topictag, create_forumtag, del_all_forumtag, 
      del_personal_forumtag, view_category, edit_personal_question, edit_all_question
    </snx:permissions>
</entry>


Parent topic

Work with stand-alone forum topics

Related reference
Forum topic entry content


   

 

});