Review Reply Screenshot Comment List Resource¶

Name	`screenshot_comments`
URI	`/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/screenshot-comments/`
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	GET - Returns the list of replies to screenshot comments made on a review reply. POST - Creates a reply to a screenshot comment on a review.
Parent Resource	Review Reply Resource
Child Resources	Review Reply Screenshot Comment Resource
Anonymous Access	Yes, if anonymous site access is enabled

Links¶

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

HTTP GET¶

Returns the list of replies to screenshot comments made on a review reply.

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.
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.

HTTP POST¶

Creates a reply to a screenshot comment on a review.

This will create a reply to a screenshot comment on a review. The new comment will contain the same dimensions of the comment being replied to, but may contain new text.

Request Parameters¶

Field	Type	Description
reply_to_id (required)	Integer	The ID of the comment being replied to.
text (required)	String	The comment text.

Errors¶

Examples¶

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

{
  "links": {
    "create": {
      "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/", 
      "method": "POST"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/", 
      "method": "GET"
    }
  }, 
  "screenshot_comments": [
    {
      "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", 
  "total_results": 1
}

application/vnd.reviewboard.org.review-reply-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>
     <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>
   </item>
  </array>
 </screenshot_comments>
 <links>
  <self>
   <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/</href>
   <method>GET</method>
  </self>
  <create>
   <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/</href>
   <method>POST</method>
  </create>
 </links>
</rsp>