Home
Get a feed of a file's comments
Get a feed that lists all of the comments associated with a file. This returns a feed of all comments associated with a file.
Atom API request details
Resource Description /basic/anonymous/api/userlibrary/{userid}/document/{document-id}/feed?category=comment A feed of comments associated with all public files. Do not authenticate this request. /basic/api/userlibrary/{userid}/document/{document-id}/feed?category=comment A feed of comments associated with files to which you have access. You must authenticate this request. {document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document and {userid} is the value of the person's <snx:userid>. See Searching Profiles to find out how to determine a person's user ID. Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).
Input parameters
Parameter Description category This parameter is required.
Resource type to include in the response. This parameter should always be set to comment. If you do not specify a category, comment is returned. 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. Options are uuid and label. Specify label if the URL instead contains the value from the <td:label> element of a file Atom entry. page Page number. Specifies the page to be returned assuming a constant page size. The default value is 1. pageSize Page size. Specifies the number of items to include in a paged request. The default value is 10. Specify the page size in increments of ten. sI Start index. Specifies the start index (as a number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided. sortOrder String. Specifies what to sort the returned entries by. Options are:
- created
- Organize the entries by comment creation date.
- downloaded
- Organize the entries by the number of times the file has been downloaded.
- modified
- Organize the entries by comment modification date.
- published
- Organize the entries by comment publication date.
- title
- Organize the entries by comment title.
sortBy String. Defines the order in which to sort the results. Options are:
- asc
- Ascending.
- desc
- Descending. This value is the default value.
Related reference