This documentation covers Review Board 1.7. You can select a version above or view the latest documentation.

Review Screenshot Comment List Resource¶

Name	`screenshot_comments`
URI	`/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/`
Description	Provides information on screenshots comments made on a review. If the review is a draft, then comments can be added, deleted, or changed on this list. However, if the review is already published, then no changes can be made.
HTTP Methods	GET - Returns the list of screenshot comments made on a review. POST - Creates a screenshot comment on a review.
Parent Resource	Review Resource
Child Resources	Review Screenshot Comment Resource
Anonymous Access	Yes, if anonymous site access is enabled

Links¶

Name	Method	Resource
create	POST	Review Screenshot Comment List Resource
self	GET	Review Screenshot Comment List Resource

HTTP GET¶

Returns the list of screenshot comments made on a review.

Request Parameters¶

Field	Type	Description
counts-only (optional)	Boolean	If specified, a single `count` field is returned with the number of results, instead of the results themselves.
max-results (optional)	Integer	The maximum number of results to return in this list. By default, this is 25. There is a hard limit of 200; if you need more than 200 results, you will need to make more than one request, using the “next” pagination link.
start (optional)	Integer	The 0-based index of the first result in the list. The start index is usually the previous start index plus the number of previous results. By default, this is 0.

Errors¶

105 - Invalid Form Data

HTTP POST¶

Creates a screenshot comment on a review.

This will create a new comment on a screenshot as part of a review. The comment contains text and dimensions for the area being commented on.

Request Parameters¶

Field	Type	Description
h (required)	Integer	The height of the comment region.
issue_opened (optional)	Boolean	Whether or not the comment opens an issue.
screenshot_id (required)	Integer	The ID of the screenshot being commented on.
text (required)	String	The comment text.
w (required)	Integer	The width of the comment region.
x (required)	Integer	The X location for the comment.
y (required)	Integer	The Y location for the comment.

Errors¶

Examples¶

application/vnd.reviewboard.org.screenshot-comments+json¶

{
  "links": {
    "create": {
      "href": "http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/", 
      "method": "POST"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/", 
      "method": "GET"
    }
  }, 
  "screenshot_comments": [
    {
      "h": 44, 
      "id": 1, 
      "issue_opened": false, 
      "issue_status": "", 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "DELETE"
        }, 
        "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/screenshot-comments/1/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "PUT"
        }, 
        "user": {
          "href": "http://reviews.example.com/api/users/admin/", 
          "method": "GET", 
          "title": "admin"
        }
      }, 
      "public": true, 
      "text": "This comment makes an astute observation.", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png", 
      "timestamp": "2010-08-28T02:24:31.087Z", 
      "w": 198, 
      "x": 132, 
      "y": 109
    }
  ], 
  "stat": "ok", 
  "total_results": 1
}

application/vnd.reviewboard.org.screenshot-comments+xml¶

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <total_results>1</total_results>
 <stat>ok</stat>
 <screenshot_comments>
  <array>
   <item>
    <issue_opened>0</issue_opened>
    <links>
     <user>
      <href>http://reviews.example.com/api/users/admin/</href>
      <method>GET</method>
      <title>admin</title>
     </user>
     <self>
      <href>http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/</href>
      <method>PUT</method>
     </update>
     <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>
     <delete>
      <href>http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <timestamp>2010-08-28T02:24:31.087Z</timestamp>
    <id>1</id>
    <thumbnail_url>/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png</thumbnail_url>
    <w>198</w>
    <text>This comment makes an astute observation.</text>
    <y>109</y>
    <x>132</x>
    <h>44</h>
    <public>1</public>
    <issue_status></issue_status>
   </item>
  </array>
 </screenshot_comments>
 <links>
  <self>
   <href>http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/</href>
   <method>GET</method>
  </self>
  <create>
   <href>http://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/</href>
   <method>POST</method>
  </create>
 </links>
</rsp>