Python API

The Python API function to handle comments through the Comment-handler is added to the Expression handler. A description of the API and example codes are in the Expression handler documentation. The supported use cases in Python API are:

• Get comment authors (comment creators) with function getAuthor()
• to create new comments with the function CommentUtil.createComment()
  • Note: To get Integration user as author to Comment data card, the user must have a Person data card
  • Available parameters for method are createComment(message, date, author, type) → date representing Creation date and time
  • Allowed types are 'user-written' and 'pythonapi-generated', if unspecified, 'user-written' will be used.
• to get comment content with the function getComment()
• to get comment creation date with the function getDate()
• to get comment type if comment is created by file upload action or created by user with the function getType()
• to delete comments with the function CommentUtil.deleteComment()
• to modify comment with the function setComment()