The Comment Object

{
  "id": 1, // assigned by codePost API
  "text": "Missing a semicolon",
  "pointDelta": 1,
  "startChar": 4,
  "endChar": 9,
  "startLine": 1,
  "endLine": 2,
  "file": 1,
  "rubricComment": null,
  "author": "[email protected]",
  "color": "",
}
AttributeTypeDescription
idintegerUnique identifier for the object.
textstringThe text of the comment. This is text is shown both to graders and to students. It is the customization of the comment as written by graders.
pointDeltaintegerThe delta the comment will apply to its ancestor submission's grade. A positive value indicates a deduction, while a negative value indicates an addition. null indicates a value of 0.
startCharintegerThe index of the character on which the comment begins. The index is relative to the beginning of the character's line. Must be greater than or equal to 0. If startLine == endLine, cannot be greater than endChar.
endCharintegerThe index of the character on which the comment ends. The index is relative to the beginning of the character's line. Must be greater than or equal to 0. If startLine == endLine, cannot be less than endChar.
startLineintegerThe line of the parent File's code on which the comment should begin. Must be greater than or equal to 0, and cannot be greater than endLine.
endLineintegerThe line of the parent File's code on which the comment should end. Must be greater than or equal to 0, cannot be less than startLine, and cannot exceed the number of lines in the file.
fileintegerThe ID of the file to which this Comment applies.
rubricCommentintegerThe ID of a linked RubricComment. This field should be null if the comment isn't linked to any RubricComment.
authorstringThe user who created this Comment.
feedbackintegerAn integer representing the feedback applied to this comment. Currently only valid if rubricComment is not null.
colorstringA hex string that indicates the color which a comment will render in codePost.