Review Board 2.0 Documentation

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

Jump to >

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

Review Screenshot Comment 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_comment
URI /api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/
HTTP Methods
  • DELETE - Deletes the comment.
  • GET - Returns information on the comment.
  • PUT - Updates a screenshot comment.
Parent Resource Review Screenshot Comment List Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

Fields

extra_dataDictionary Extra data as part of the comment. This depends on what is being commented on, and may be used in conjunction with an extension.
hInteger The height of the comment region on the screenshot.
idInteger The numeric ID of the comment.
issue_openedBoolean Whether or not a comment opens an issue.
issue_statusOne of dropped, open, resolved The status of an issue.
publicBoolean Whether or not the comment is part of a public review.
screenshotScreenshot Resource The screenshot the comment was made on.
textRich Text The comment text.
text_typeOne of plain, markdown, html The mode for the comment text field.
thumbnail_urlString The URL to an image showing what was commented on.
timestampString The date and time that the comment was made (in YYYY-MM-DD HH:MM:SS format).
userUser Resource The user who made the comment.
wInteger The width of the comment region on the screenshot.
xInteger The X location of the comment region on the screenshot.
yInteger The Y location of the comment region on the screenshot.

HTTP DELETE

Deletes the comment.

This will remove the comment from the review. This cannot be undone.

Only comments on draft reviews can be deleted. Attempting to delete a published comment will return a Permission Denied error.

Instead of a payload response on success, this will return HTTP 204 No Content.

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

HTTP GET

Returns information on the comment.

This contains the comment text, time the comment was made, and the location of the comment region on the screenshot, amongst other information. It can be used to reconstruct the exact position of the comment for use as an overlay on the screenshot.

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

HTTP PUT

Updates a screenshot comment.

This can update the text or region of an existing comment. It can only be done for comments that are part of a draft review.

Request Parameters

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.
hInteger The height of the comment region.
issue_openedBoolean Whether or not the comment opens an issue.
issue_statusOne of dropped, open, resolved The status of an open issue.
textRich Text The comment text.
text_typeOne of plain, markdown The new content type for the comment text field. The default is to leave the type unchanged.
wInteger The width of the comment region.
xInteger The X location for the comment.
yInteger The Y location for the comment.

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-comment+json

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

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

{
  "screenshot_comment": {
    "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"
}