resources/comments/list

Enumerates segment level or document level comments for a scope.

URL

(POST) /resources/comments/list

PARAMETERS

The parameters are a JSON object included in the request body:

scope	The scope object. The segment must be within the scope. NOTE: This method does not support the Global Search scope.	Mandatory
cty	Type of comments to retrieve: "s": Segment level comment. "d": Document level comment.	Mandatory
query	An optional query object. This allows to constrain the segments to fetch comments for.	Optional
locales	Optional filter on languages of comments. If null then comments will be retrieved for all scope languages.	Optional
txt	Optional text filter.	Optional
cat	Optionally, the comments category. Defines the category (a name) as well as visual style.	Optional
uid	Optional filter on the user who added/updated the comment.	Optional
tsk	Optional filter on the task code stored with a comment if the comment was added by a worker in the framework of a job.	Optional
asc	Optional sort order. False (default) = sort with most recent comments on top. True = Oldest comments on top.
skip	Used for pagination. 0 = get comments from the start. If not specified, value will be 0.	Optional
take	Used for pagination. Number of pages to retrieve. If not set, value will be 30.	Optional
knownPersons	Optional array of person/user ids for which we do not need name and company, since we already have this information. Try to provide the person ids if you already have details as this will speed up performance.	Optional
solved	Optional boolean property to filter the comments by its solved status. (false) means to get the non-solved comments. (true) means to get the solved comments. (null or not sending the property) means to get all the comments	Optional

Pagination: The skip/take values do not necessarily count actual comments. They are system internal numbers only.

The actual skip/take values to move to the next or previous set of comments is included with the method result.

RESULTS

A JSON with these properties:

comments	An array of all comments of the segment, sorted by descending date. It includes comments in all the scope languages to which the user has access. See Comment (Object) for details.
persons	An object containing the persons referred to by comments or revisions. Note: Excludes persons contained in parameter knownpersons. Excludes persons that the user cannot see. There is an access right to prevent a user from viewing user and company names. See Persons List (Object) for details.
locales	The list of locales in which we actually did search comments.
hasmore	Boolean indicating if there are more results available.