Screenshot Comment List Resource¶

Name	`screenshot_comments`
URI	`/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/`
Description	Provides information on screenshots comments made on a review request. The list of comments cannot be modified from this resource. It’s meant purely as a way to see existing comments that were made on a diff. These comments will span all public reviews.
HTTP Methods	GET - Returns the list of screenshot comments on a screenshot.
Parent Resource	Screenshot Resource
Child Resources	None
Anonymous Access	Yes, if anonymous site access is enabled

Links¶

Name	Method	Resource
self	GET	Screenshot Comment List Resource

HTTP GET¶

Returns the list of screenshot comments on a screenshot.

This list of comments will cover all comments made on this screenshot from all reviews.

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

Examples¶

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

{
  "links": {
    "self": {
      "href": "http://reviews.example.com/api/review-requests/8/screenshots/1/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
    }, 
    {
      "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.", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png", 
      "timestamp": "2010-08-28T02:26:16.490Z", 
      "w": 198, 
      "x": 132, 
      "y": 109
    }, 
    {
      "h": 44, 
      "id": 3, 
      "issue_opened": false, 
      "issue_status": "", 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/11/screenshot-comments/3/", 
          "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/11/screenshot-comments/3/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/11/screenshot-comments/3/", 
          "method": "PUT"
        }, 
        "user": {
          "href": "http://reviews.example.com/api/users/admin/", 
          "method": "GET", 
          "title": "admin"
        }
      }, 
      "public": false, 
      "text": "This font should be in Comic Sans.", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png", 
      "timestamp": "2010-08-28T23:54:39.853Z", 
      "w": 198, 
      "x": 132, 
      "y": 109
    }
  ], 
  "stat": "ok", 
  "total_results": 3
}

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

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <total_results>3</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>
   <item>
    <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-28T02:26:16.490Z</timestamp>
    <public>1</public>
    <thumbnail_url>/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png</thumbnail_url>
    <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>
   </item>
   <item>
    <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/11/screenshot-comments/3/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/11/screenshot-comments/3/</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/11/screenshot-comments/3/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <timestamp>2010-08-28T23:54:39.853Z</timestamp>
    <public>0</public>
    <thumbnail_url>/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png</thumbnail_url>
    <w>198</w>
    <text>This font should be in Comic Sans.</text>
    <y>109</y>
    <x>132</x>
    <h>44</h>
    <id>3</id>
    <issue_status></issue_status>
   </item>
  </array>
 </screenshot_comments>
 <links>
  <self>
   <href>http://reviews.example.com/api/review-requests/8/screenshots/1/screenshot-comments/</href>
   <method>GET</method>
  </self>
 </links>
</rsp>