Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

scomments

An array of segment level comments. See Comment (Object) for details.

scommentsHasMore

True if there are more segment level comments.

Find more elements using this method: resources/comments/list and set skip to the value of "take" used with this call.

dcomments

An array of document level comments. See Comment (Object) for details.

Find more elements using this method: resources/comments/list and set skip to the value of "take" used with this call.

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

A list of all locales available for this segment and which are within the scope. You can use these in a comments/revisions language filter.

rights

A few access rights that are specifically useful when working with the results:

  • canSendEmail: When a user adds/edits a comment, this boolean tells if the user can notify the comment by email or not.
  • canAdd: Tells if the user can add a new comment in one of the locales.

Note: When using the APIs to add/edit/delete comments, you may obtain a not authorized information even when the edit, canAdd or canSendEmail properties are true. The reason for this is that further detailed access rights check are done upon those advanced operations.

...