Create a comment
Create a comment programmatically.See Authenticating requests for information about how to authenticate the request.
Table 1. Atom API request details
Method Resource address Input representation Description POST /basic/api/userlibrary/{userid}/document/{document-id}/feed comment Atom entry document or plain text Adds a comment to the specified file.
- {userid} is the value of the <snx:userid> of the person who owns the file. See Search Profiles for information about how to determine a person's user ID.
- {document-id} is the value of the <td:uuid> or <td:label> of the file and can be found in the file's Atom document. If you specify the document by label, also provide the identifier=label parameter as part of the request.
You can use this input parameter with the POST request.
Table 2. Input parameters
Parameter Description identifier Indicates how the document is identified in the {document-id} variable segment of the web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a File Atom entry. Specify "label" if the URL instead contains the value from the <td:label> element of a File Atom entry.
Input
You can provide the comment as an Atom entry document or as plain text in the request header.
- To add the comment using an Atom entry document, provide the following input:
- Content-Type: application/atom+xml
- Content-Length: <length-of-xml-message/>
- Request body: atom entry element
- To add the comment using plain text, provide the following input:
- Content-Type: text/plain
- Content-Length: <length-of-request-body/>
- Request body: the comment in plain text
Output
A comment Atom entry document that includes the unique identifier of the comment and URLs to retrieve the comment.Returned HTTP headers
HTTP/1.1 201 Created
Indicates that the comment entry was successfully created. If an error occurs, this header contains one of the error codes.
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 404 Not Found Can occur if you specify the document ID using the document label, but do not provide the identifier parameter to indicate that you are using the label as the identifier.
Parent topic
Work with commentsRelated reference
Search Profiles programmatically
Files comment content
});