Product Documentation articleComment: lq851
Added by IBM contributorTao YT Yan | Edited by IBM contributorCraig Lordan on October 21, 2011 | Version 9
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


Create a comment
Delete a comment
Retrieve a comment
Retrieve content for comment
Update a comment

Description


A resource that contains an opinion about a related Document or Draft resource.

Entry Elements


All elements are in XML namespace "http://www.w3.org/2005/Atom", except as noted.
All elements prefixed td are in the XML namespace "urn:ibm.com/td".
Each element can appear only once, except as noted.

Tag
Required
Description
link rel="self"YIdentifies a resource equivalent to the containing element. as defined in Atom spec.
link rel= "alternate"YIdentifies an alternate version of the resource described by the containing element. as defined in Atom spec.
link rel= "edit"NIdentifies the resource that is editable.
link rel= "parent"NPoints to the parent page, parent folder or parent place.
link rel="parent-page"NOnly be available for comment entries and it will point to the page where the comments are related.
link rel= "edit-media"N"edit-media" link accompanies "attachmentX" link. It points to the attachment itself for edit.
link rel= "current"NThe current link points to the document/page/folder feed itself.
link rel= "enclosure"NThe link points to document's attachment, or page feed.
id
Y
unique identifier of a resource, as defined in Atom spec
author
Y
The feed author or entry author, the one who creates the resource. If the resource is systemic, the author field could be blank
title
Y
The title of feed or entry
published
N
The last modified date of entry
updated
N
The last modified date of feed or entry
summary
Y
The abstract of feed or entry
td:created
Y
The created date of entry
td:modified
Y
The modified date of entry
td:modifier
Y
The last editor of the entry
categoryYIt indicates entry type, including page/document/draft/draftpage/folder.
content
N
The link points to document's attachment, folder feed or page feed.
td:uuid
Y
unique identifier of a resource
td:totalNumberNTotal number of Entries in a Feed.
generatorYidentifies the agent used to generate a feed, for debugging and other purposes. as defined in Atom spec.
serverdateYDate of server.
td:documenttypeNdocument type for this resource.
sourceNallow the aggregation of entries from different feeds while retaining information about an entry's source feed. as defined in Atom spec.
td:responseCountNThe number of document/page's comment
td:depthNIf the entry is returned from a view feed, this value shows how much the document is indented in this view (used for showing responses accordingly)
nameYThe display name of a person or a group.
td:documentUuidNThe unique identification of this document.

Example 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>