Files comment content 

Lists the elements in the Atom entry document of a comment.

All elements are in the http://www.w3.org/2005/Atom namespace, except those that are prefixed as follows:

td

snx

Table 1. Comment elements

Element How treated on input Description
<id> Required on PUT request. Unique identifier of a comment formatted following the URN specification.
<td:uuid> Ignored Unique identifier of a comment. Provide this value as the {comment-id} when constructing the resource from which to retrieve a file comment. This ID is created by the server when you post a comment.
<title type="text"> Optional Title of the comment in text format. The type attribute is optional; type="text" is the default and only format allowed.
<category scheme="tag:ibm.com,2006:td/type" term="comment" label="comment"/> Required Identifies a comment document Atom entry.
<link rel="alternate" type="text/html" href="alternate_url"> Ignored A direct link to the comment within the Files web application. Operations supported on the value of the href attribute:

  • GET: HTML for display in browser.

<link rel="self" type="application/atom+xml" href="self_url"> Ignored Use the web address in the href attribute to obtain an Atom entry document containing a complete Atom representation of this file. The following operation is supported:

  • GET: Use the web address to obtain full representation of the comment as an Atom entry document.

<link rel="edit" href="edit-url"> Ignored Use the web address in the href attribute to obtain a complete representation of this comment entry. If you are a comment author or file owner, the following operations are supported:

  • GET: Use the web address to obtain a full representation of this comment as an Atom entry document.

  • PUT: Use the web address to update this comment.

  • DELETE: Use the web address to delete this comment.

<content type="text"> Required Text of this comment. The type attribute is optional; type="text" is the default and only format allowed.
<td:created> Optional Creation timestamp in Atom format.
<td:modified> Optional The date that the comment was last updated. Timestamp in Atom format.
<td:versionLabel> Ignored Label of the version of the document at the time that the comment was created.
<updated> Ignored The date that the comment was last updated, as defined in the Atom specification.
<published> Ignored The date the comment was initially published, as defined in the Atom specification.
<td:modifier> Optional The person who last modified the comment. Contains the person's name, snx:userid, and email address (if exposed).
<author> Ignored The person who created the comment.


Parent topic

Files Atom entry types

Related reference
Create a comment
Retrieve a file comment
Update a comment
Delete a comment


   

 

});