Screenshot Comment List Resource¶

Added in 1.6

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 screenshot. These comments will span all public reviews.

Details¶

Name	`screenshot_comments`
URI	`/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/`
Token Policy ID	`screenshot_comment`
HTTP Methods	GET - Returns the list of screenshot comments on a screenshot.
Parent Resource	Screenshot Resource
Child Resources	None

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¶

counts-onlyBoolean	If specified, a single `count` field is returned with the number of results, instead of the results themselves.
max-resultsInteger	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.
startInteger	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¶

100 - Does Not ExistHTTP 404 - Not Found	Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden	You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized	You are not logged in
105 - Invalid Form DataHTTP 400 - Bad Request	One or more fields had errors
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden	Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden	OAuth2 token access for this resource is prohibited.

Examples¶

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

$ curl https://reviews.example.com/api/review-requests/8/screenshots/1/screenshot-comments/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 3590
Content-Type: application/vnd.reviewboard.org.screenshot-comments+json
ETag: df8b5294a8aa66dc806834d2eba2c9eec9cb76ee
Item-Content-Type: application/vnd.reviewboard.org.screenshot-comment+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "links": {
    "self": {
      "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/screenshot-comments/", 
      "method": "GET"
    }
  }, 
  "screenshot_comments": [
    {
      "extra_data": {}, 
      "h": 44, 
      "id": 1, 
      "issue_opened": false, 
      "issue_status": "", 
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "DELETE"
        }, 
        "screenshot": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/", 
          "method": "GET", 
          "title": "Example Screenshot (uploaded/images/2010/08/13/screenshot1.png)"
        }, 
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "GET"
        }, 
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "PUT"
        }, 
        "user": {
          "href": "https://reviews.example.com/api/users/admin/", 
          "method": "GET", 
          "title": "admin"
        }
      }, 
      "public": true, 
      "text": "This comment makes an astute observation.", 
      "text_type": "plain", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png", 
      "timestamp": "2010-08-28T02:24:31Z", 
      "w": 198, 
      "x": 132, 
      "y": 109
    }, 
    {
      "extra_data": {}, 
      "h": 44, 
      "id": 2, 
      "issue_opened": false, 
      "issue_status": "", 
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/", 
          "method": "DELETE"
        }, 
        "reply_to": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "GET", 
          "title": "This comment makes an astute observation."
        }, 
        "screenshot": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/", 
          "method": "GET", 
          "title": "Example Screenshot (uploaded/images/2010/08/13/screenshot1.png)"
        }, 
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/", 
          "method": "GET"
        }, 
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/screenshot-comments/2/", 
          "method": "PUT"
        }, 
        "user": {
          "href": "https://reviews.example.com/api/users/admin/", 
          "method": "GET", 
          "title": "admin"
        }
      }, 
      "public": true, 
      "text": "A very witty comeback to an astute observation.", 
      "text_type": "plain", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png", 
      "timestamp": "2010-08-28T02:26:16Z", 
      "w": 198, 
      "x": 132, 
      "y": 109
    }, 
    {
      "extra_data": {}, 
      "h": 44, 
      "id": 3, 
      "issue_opened": false, 
      "issue_status": "", 
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/11/screenshot-comments/3/", 
          "method": "DELETE"
        }, 
        "reply_to": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/1/", 
          "method": "GET", 
          "title": "This comment makes an astute observation."
        }, 
        "screenshot": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/", 
          "method": "GET", 
          "title": "Example Screenshot (uploaded/images/2010/08/13/screenshot1.png)"
        }, 
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/11/screenshot-comments/3/", 
          "method": "GET"
        }, 
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/11/screenshot-comments/3/", 
          "method": "PUT"
        }, 
        "user": {
          "href": "https://reviews.example.com/api/users/admin/", 
          "method": "GET", 
          "title": "admin"
        }
      }, 
      "public": false, 
      "text": "This font should be in Comic Sans.", 
      "text_type": "plain", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_132_109_198_44.png", 
      "timestamp": "2010-08-28T23:54:39Z", 
      "w": 198, 
      "x": 132, 
      "y": 109
    }
  ], 
  "stat": "ok", 
  "total_results": 3
}