Product Documentation articleCreate a comment: lq851
Added by IBM contributorTao YT Yan | Edited by IBM contributorDana Liburdi on April 18, 2011 | Version 3
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.
Tags: API

Overview

This is the specification for applications that create Comment resources.

URL endpoints

POST a Comment Atom entry to one of the following URL formats:

URL
Description
/library/{library-id}/page/{document-id}/feed
Create a comment

Authentication

This method requires authentication with 'AddChild' permission.

Arguments


The following HTTP headers are supported on this operation:
Header
Required
Description
Content-Type
yes
Used to specify the Mime type for the content being sent to the server.
POST and PUT operations will return HTTP response code 400 (Bad request) when this header is not present in the incoming request.
If the collection does not support the specified content type, the server will return HTTP response code 415 (Unsupported media type).

Error Codes

The following error codes could appear in a response body for an invalid request:

Error Code
Description
Unknown
Returned when the cause of an error is unknown
AccessDenied
Returned when the cause of an error is due to a permission restriction
ItemNotFound
Returned when the cause of an error is related to a resource not being found
Unsupported Operation
Returned when the operation is not supported


Example Request for Lotus Quickr 8.5 Domino


POST http://example.com/dm/atom/library/_Papiplace1_RMain.nsf/page/_Papiplace1_RMain.nsf_D1310D3BE7BE3BC194825785B0034A64B/feed?draft=false&noAuthHeader=true
Accept: */*
Accept-Language: en-us,ar-SA;q=0.7,zh-CN;q=0.3
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; MALC; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)
Host: example.com

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<title type="text">Re: page</title>
<category term="comment" scheme="tag:ibm.com,2006:td/type" label="comment"></category>
<content type="text"></content>
<summary type="html"><![CDATA[hello]]></summary>
</entry>

Example Response for Lotus Quickr 8.5 for Domino


HTTP/1.1 201 Created
Server: Lotus-Domino
Content-Type: application/atom+xml
Location: http://example.com/dm/atom/library/_Papiplace1_RMain/document/_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B/entry
X-Server: Lotus Domino

<?xml version="1.0" encoding="utf-8"?>
<entry xml:base="http://example.com/" xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
<id>urn:lsid:ibm.com:quickr:_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B</id>
<link href="http://example.com/dm/atom/library/_Papiplace1_RMain/document/_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B/entry" rel="self"/>
<link href="http://example.com/LotusQuickr/apiplace1/Main.nsf/h_Index/637CCC8E8667D5B24825785B00354A02?OpenDocument" rel="alternate"/>
<link href="http://example.com/dm/atom/library/_Papiplace1_RMain/document/_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B/entry" rel="edit"/>
<link href="http://example.com/dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FCD0EF97D625305B90525670800167213/entry" rel="parent"/>
<link href="http://example.com/dm/atom/library/_Papiplace1_RMain/page/_Papiplace1_RMain_D1310D3BE7BE3BC194825785B0034A64B/entry" rel="parent-page"/>
<link href="http://example.com/dm/atom/library/_Papiplace1_RMain/document/_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B/feed" rel="current">
</link><link href="http://example.com/dm/atom/library/_Papiplace1_RMain/document/_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B/media" rel="edit-media"/>
<link href="http://example.com/dm/atom/library/_Papiplace1_RMain/document/_Papiplace1_RMain_D637CCC8E8667D5B24825785B00354A02_A_40D1310D3BE7BE3BC194825785B0034A64B/media" rel="enclosure" type="application/msword" title="Re: page" hreflang="en" length="0"/>
<source xmlns:axis2ns417="http://www.w3.org/2007/app">
<collection href="http://example.com/dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FCD0EF97D625305B90525670800167213/entry/feed" xmlns="http://www.w3.org/2007/app">
<title type="text" xmlns:atom="http://www.w3.org/2005/Atom">Re: page</title>
</collection>
</source>
<author>
<uri>uid=SusanAdams261%2Fou=Users%2Fl=Westford%2Fst=Massachusetts%2Fc=US%2Fou=Lotus%2Fo=Software%20group%2Fdc=ibm%2Fdc=com</uri>
<name>Susan Adams261</name>
<email></email>
</author>
<td:modifier>
<td:uri>uid=SusanAdams261%2Fou=Users%2Fl=Westford%2Fst=Massachusetts%2Fc=US%2Fou=Lotus%2Fo=Software%20group%2Fdc=ibm%2Fdc=com</td:uri>
<td:name>Susan Adams261</td:name>
<td:email></td:email>
</td:modifier>
<title type="text">Re: page</title>
<updated>2011-03-22T09:42:03Z</updated>
<published>2011-03-22T09:42:03Z</published>
<summary type="html"><![CDATA

hello]></summary>

<category term="document" scheme="tag:ibm.com,2006:td/type" label="document"/>
</entry>