Crucible 2.3 : Review Service - Comments
This page last changed on Nov 19, 2009 by edawson.
On this page:
CommentsAdd a Reply to a CommentPOST /reviews-v1/<review id>/comments/<comment id>/replies Description: The POST data is a generalCommentData structure. Add Comment to a Review ItemPOST /reviews-v1/<review id>/reviewitems/<review item id>/comments Description: The POST data is a versionedLineCommentData structure. Add General Comment to a ReviewPOST /reviews-v1/<review id>/comments Description: The POST data is a generalCommentData structure. Delete a CommentDELETE /reviews-v1/<review id>/comments/<comment id> Description: Delete a ReplyDELETE /reviews-v1/<review id>/comments/<comment id>/replies/<reply id> Description: Get a CommentGET /reviews-v1/<review id>/comments/<comment id> Description: Comment Read Status:
Anonymous access requests and users who do not have permission to comment on a review always return the READ value. Example XML Return Data: <comments> <versionedLineCommentData> ... </versionedLineCommentData> </comments> Example JSON Return Data: {"comments": [ {"versionedCommentData": ...} ]}
Get Comments on a Review ItemGET /reviews-v1/<review id>/reviewitems/<review item id>/comments Description: Example XML Return Data: <comments> <versionedLineCommentData> ... </versionedLineCommentData> ... </comments> Example JSON Return Data: {"comments": [ {"versionedCommentData": ...} {"versionedCommentData": ...} ]}
Get Comments on FilesGET /reviews-v1/<review id>/comments/versioned Description: Example XML Return Data: <comments> <versionedLineCommentData> ... </versionedLineCommentData> ... </comments> Example JSON Return Data: {"comments": [ {"versionedCommentData": ...} {"versionedCommentData": ...} ]}
Get General CommentsGET /reviews-v1/<review id>/comments/general Description: Example XML Return Data: <comments> <generalCommentData> ... </generalCommentData> </comments> Example JSON Return Data: {"comments": [ {"generalCommentData":{"createDate":"2008-10-30T16:32:51.032+1100", "defectApproved":false, "defectRaised":true, "deleted":false, "draft":false, "readStatus":"UNREAD", "message":"A general comment.", "metrics":[ {"entry":{"key":"classification","value":[{"configVersion":1},"Not conforming to standards"]}}, {"entry":{"key":"rank","value":[{"configVersion":1},"Minor"]}}], "permaIdAsString":"CMT:1", "replies":"", "user":{"displayName":"joe lowercase","userName":"joe"},"permId":{"id":"CMT:1"}}, {"generalCommentData":{"createDate":"2008-11-03T10:26:50.951+1100", "defectApproved":false, "defectRaised":false, "deleted":false, "draft":false, "message":"Another general comment.", "metrics":"", "permaIdAsString":"CMT:4", "replies":"", "user":{"displayName":"joe lowercase","userName":"joe"}, "permId":{"id":"CMT:4"}} ]}
Get Review CommentsGET /reviews-v1/<review id>/comments Description: Example XML Return Data: <comments> <generalCommentData> <createDate>2008-09-16T16:28:02.833+1000</createDate> <defectApproved>false</defectApproved> <defectRaised>false</defectRaised> <deleted>false</deleted> <draft>false</draft> <readStatus>READ</readStatus> <message>This is a general comment.</message> <metrics/> <permaIdAsString>CMT:1</permaIdAsString> <replies/> <user> <displayName>Matt Quail</displayName> <userName>matt</userName> </user> <permId> <id>CMT:1</id> </permId> </generalCommentData> <versionedLineCommentData> <createDate>2008-09-16T16:28:26.432+1000</createDate> <defectApproved>false</defectApproved> <defectRaised>true</defectRaised> <deleted>false</deleted> <draft>false</draft> <readStatus>LEAVE_READ</readStatus> <message>This is a revision level defect.</message> <metrics> <entry> <key>classification</key> <value> <configVersion>1</configVersion> <value>Inconsistent</value> </value> </entry> <entry> <key>rank</key> <value> <configVersion>1</configVersion> <value>Major</value> </value> </entry> </metrics> <permaIdAsString>CMT:2</permaIdAsString> <replies/> <user> <displayName>Matt Quail</displayName> <userName>matt</userName> </user> <permaId> <id>CMT:2</id> </permaId> <reviewItemId> <id>CFR-4</id> </reviewItemId> </versionedLineCommentData> <versionedLineCommentData> <createDate>2008-09-16T16:28:54.604+1000</createDate> <defectApproved>false</defectApproved> <defectRaised>false</defectRaised> <deleted>false</deleted> <draft>false</draft> <readStatus>UNREAD</readStatus> <message>This is a comment covering two lines of a revision.</message> <metrics/> <permaIdAsString>CMT:3</permaIdAsString> <replies/> <user> <displayName>Matt Quail</displayName> <userName>matt</userName> </user> <permaId> <id>CMT:3</id> </permaId> <reviewItemId> <id>CFR-4</id> </reviewItemId> <fromLineRange>2-3</fromLineRange> <toLineRange>3-4</toLineRange> </versionedLineCommentData> </comments> Example JSON Return Data: {"comments": { "generalCommentData":{ "createDate":"2008-10-30T16:32:51.032+1100", "defectApproved":false, "defectRaised":true, "deleted":false, "draft":false, "readStatus":"READ", "message":"A general comment.", "metrics": [ "entry":{"key":"classification","value":{"configVersion":1},"Not conforming to standards"}, entry":{"key":"rank","value":{"configVersion":1},"Minor"}], "permaIdAsString":"CMT:1", "replies":"", "user":{"displayName":"joe lowercase","userName":"joe"}, "permId":{"id":"CMT:1"}, "versionedLineCommentData": [ {"createDate":"2008-10-30T16:33:02.726+1100", "defectApproved":false, "defectRaised":false, "deleted":false, "draft":false, "readStatus":"LEAVE_READ", "message":"This is wrong", "metrics":"", "permaIdAsString":"CMT:2", "replies":"", "user":{"displayName":"joe lowercase","userName":"joe"}, "permaId":{"id":"CMT:2"}, "reviewItemId":{"id":"CFR-4"}, "toLineRange":"1-2"}, {"createDate":"2008-10-30T16:34:12.535+1100", "defectApproved":false, "defectRaised":false, "deleted":false, "draft":false, "readStatus":"UNREAD", "message":"This is a revision level defect.", "metrics":"", "permaIdAsString":"CMT:3", "replies":"", "user":{"displayName":"joe lowercase","userName":"joe"}, "permaId":{"id":"CMT:3"}, "reviewItemId":{"id":"CFR-5"}} ]}
Mark a Comment as ReadPOST /reviews-v1/<review id>/comments/<comment id>/markAsRead Description: Status Code: Mark a Comment as Leave UnreadPOST /reviews-v1/<review id>/comments/<comment id>/markAsLeaveUnread Description: Status Code: Mark all Comments as ReadPOST /reviews-v1/<review id>/comments/markAllAsRead Description: Status Code: Get the Replies to a CommentGET /reviews-v1/<review id>/comments/<comment id>/replies Description: Example XML Return Data: <comments> <generalCommentData> ... </generalCommentData> ... </comments> Example JSON Return Data: {"comments": [ {"generalCommentData": ...} {"generalCommentData": ...} ]}
Publish a Draft CommentPOST /reviews-v1/<review id>/publish/<comment id> Description: Publish All Draft CommentsPOST /reviews-v1/<review id>/publish Description: Update a CommentPOST /reviews-v1/<review id>/comments/<comment id> Description: The POST data is a generalCommentData structure. |
![]() |
Document generated by Confluence on Jul 29, 2010 20:01 |