Review Board 2.0 Documentation

Need help? Talk to us today about a support contract!

This documentation covers Review Board 2.0. You can see the latest Review Board documentation or all other versions.

Review Screenshot Comment List Resource¶

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.

Details¶

Name	`screenshot_comments`
URI	`/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/`
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¶

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

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¶

hInteger	Required The height of the comment region.
screenshot_idInteger	Required The ID of the screenshot being commented on.
textRich Text	Required The comment text.
wInteger	Required The width of the comment region.
xInteger	Required The X location for the comment.
yInteger	Required The Y location for the comment.
force_text_typeOne of `plain`, `markdown`, `html`	The text type, if any, to force for returned text fields. The contents will be converted to the requested type in the payload, but will not be saved as that type.
issue_openedBoolean	Whether the comment opens an issue.
text_typeOne of `plain`, `markdown`	The content type for the comment text field. The default is `plain`.

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

Examples¶

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

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

Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.screenshot-comment+json
Content-Type: application/vnd.reviewboard.org.screenshot-comments+json
X-Content-Type-Options: nosniff

{
  "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": [
    {
      "extra_data": {}, 
      "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.", 
      "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
    }
  ], 
  "stat": "ok", 
  "total_results": 1
}