Jump to >

Review Reply Screenshot Comment Resource

Name screenshot_comment
URI /api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/screenshot-comments/{comment_id}/
Description

Provides information on replies to screenshot comments made on a review reply.

If the reply is a draft, then comments can be added, deleted, or changed on this list. However, if the reply is already published, then no changed can be made.

HTTP Methods
  • DELETE - Deletes a screenshot comment from a draft reply.
  • GET - Returns information on a reply to a screenshot comment.
  • PUT - Updates a reply to a screenshot comment.
Parent Resource Review Reply Screenshot Comment List Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

Fields

Field Type Description
h Integer The height of the comment region on the screenshot.
id Integer The numeric ID of the comment.
issue_opened Boolean Whether or not a comment opens an issue.
issue_status One of dropped, open, resolved The status of an issue.
public Boolean Whether or not the comment is part of a public review.
reply_to Review Screenshot Comment Resource The comment being replied to.
screenshot Screenshot Resource The screenshot the comment was made on.
text String The comment text.
timestamp String The date and time that the comment was made (in YYYY-MM-DD HH:MM:SS format).
user User Resource The user who made the comment.
w Integer The width of the comment region on the screenshot.
x Integer The X location of the comment region on the screenshot.
y Integer The Y location of the comment region on the screenshot.

HTTP DELETE

Deletes a screenshot comment from a draft reply.

This will remove the comment from the reply. This cannot be undone.

Only comments on draft replies can be deleted. Attempting to delete a published comment will return a Permission Denied error.

Instead of a payload response, this will return HTTP 204 No Content.

HTTP GET

Returns information on a reply to a screenshot comment.

Much of the information will be identical to that of the comment being replied to. For example, the region on the screenshot. This is because the reply to the comment is meant to cover the exact same section of the screenshot that the original comment covers.

HTTP PUT

Updates a reply to a screenshot comment.

This can only update the text in the comment. The comment being replied to cannot change.

Request Parameters

Field Type Description
text (required) String The new comment text.

Examples

application/vnd.reviewboard.org.review-reply-screenshot-comment+json

{
  "screenshot_comment": {
    "h": 44, 
    "id": 2, 
    "issue_opened": false, 
    "issue_status": "", 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/", 
        "method": "DELETE"
      }, 
      "reply_to": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
        "method": "GET", 
        "title": "This comment makes an astute observation."
      }, 
      "screenshot": {
        "href": "http://reviews.example.com/api/review-requests/8/screenshots/1/", 
        "method": "GET", 
        "title": "Example Screenshot (uploaded/images/2010/08/13/screenshot1.png)"
      }, 
      "self": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/", 
        "method": "GET"
      }, 
      "update": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/", 
        "method": "PUT"
      }, 
      "user": {
        "href": "http://reviews.example.com/api/users/admin/", 
        "method": "GET", 
        "title": "admin"
      }
    }, 
    "public": true, 
    "text": "A very witty comeback to an astute observation.", 
    "timestamp": "2010-08-28 02:26:16", 
    "w": 198, 
    "x": 132, 
    "y": 109
  }, 
  "stat": "ok"
}

application/vnd.reviewboard.org.review-reply-screenshot-comment+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <screenshot_comment>
  <issue_opened>0</issue_opened>
  <links>
   <screenshot>
    <href>http://reviews.example.com/api/review-requests/8/screenshots/1/</href>
    <method>GET</method>
    <title>Example Screenshot (uploaded/images/2010/08/13/screenshot1.png)</title>
   </screenshot>
   <self>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/</href>
    <method>GET</method>
   </self>
   <update>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/</href>
    <method>PUT</method>
   </update>
   <user>
    <href>http://reviews.example.com/api/users/admin/</href>
    <method>GET</method>
    <title>admin</title>
   </user>
   <reply_to>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/</href>
    <method>GET</method>
    <title>This comment makes an astute observation.</title>
   </reply_to>
   <delete>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/</href>
    <method>DELETE</method>
   </delete>
  </links>
  <timestamp>2010-08-28 02:26:16</timestamp>
  <public>1</public>
  <w>198</w>
  <text>A very witty comeback to an astute observation.</text>
  <y>109</y>
  <x>132</x>
  <h>44</h>
  <id>2</id>
  <issue_status></issue_status>
 </screenshot_comment>
</rsp>