Screenshot List Resource¶

A resource representing a screenshot on a review request.

Details¶

Name	`screenshots`
URI	`/api/review-requests/{review_request_id}/screenshots/`
Token Policy ID	`screenshot`
HTTP Methods	GET - Returns a list of screenshots on the review request. POST - Creates a new screenshot from an uploaded file.
Parent Resource	Review Request Resource
Child Resources	Screenshot Resource

Links¶

Name	Method	Resource
create	POST	Screenshot List Resource
self	GET	Screenshot List Resource

HTTP GET¶

Returns a list of screenshots on the review request.

Each screenshot in this list is an uploaded screenshot that is shown on the review request.

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.

HTTP POST¶

Creates a new screenshot from an uploaded file.

This accepts any standard image format (PNG, GIF, JPEG) and associates it with a draft of a review request.

Creating a new screenshot will automatically create a new review request draft, if one doesn’t already exist. This screenshot will be part of that draft, and will be shown on the review request when it’s next published.

It is expected that the client will send the data as part of a multipart/form-data mimetype. The screenshot’s name and content should be stored in the path field. A typical request may look like:

-- SoMe BoUnDaRy
Content-Disposition: form-data; name=path; filename="foo.png"

<PNG content here>
-- SoMe BoUnDaRy --

Request Parameters¶

pathUploaded file	Required The screenshot to upload.
captionString	The optional caption describing 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
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.screenshots+json¶

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

HTTP 200 OK
Content-Length: 1122
Content-Type: application/vnd.reviewboard.org.screenshots+json
ETag: 1a2a15de4204575d6946ecb39808b5061f51f74b
Item-Content-Type: application/vnd.reviewboard.org.screenshot+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "links": {
    "create": {
      "href": "https://reviews.example.com/api/review-requests/8/screenshots/", 
      "method": "POST"
    }, 
    "self": {
      "href": "https://reviews.example.com/api/review-requests/8/screenshots/", 
      "method": "GET"
    }
  }, 
  "screenshots": [
    {
      "absolute_url": "https://reviews.example.com/media/uploaded/images/2010/08/13/screenshot1.png", 
      "caption": "Example Screenshot", 
      "filename": "screenshot1.png", 
      "id": 1, 
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/", 
          "method": "DELETE"
        }, 
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/screenshot-comments/", 
          "method": "GET"
        }, 
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/", 
          "method": "GET"
        }, 
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/screenshots/1/", 
          "method": "PUT"
        }
      }, 
      "path": "uploaded/images/2010/08/13/screenshot1.png", 
      "review_url": "/r/8/s/1/", 
      "thumbnail_url": "/media/uploaded/images/2010/08/13/screenshot1_400x100.png", 
      "url": "/media/uploaded/images/2010/08/13/screenshot1.png"
    }
  ], 
  "stat": "ok", 
  "total_results": 1
}