Jump to >

Draft Screenshot List Resource

Name draft_screenshots
URI /api/review-requests/{review_request_id}/draft/screenshots/
Description

Provides information on new screenshots being added to a draft of a review request.

These are screenshots that will be shown once the pending review request draft is published.

HTTP Methods
  • GET - Returns a list of draft screenshots.
  • POST - Creates a new screenshot from an uploaded file.
Parent Resource Review Request Draft Resource
Child Resources
Anonymous Access No

HTTP GET

Returns a list of draft screenshots.

Each screenshot in this list is an uploaded screenshot that will be shown in the final review request. These may include newly uploaded screenshots or screenshots that were already part of the existing review request. In the latter case, existing screenshots are shown so that their captions can be added.

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

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

Field Type Description
caption (optional) String The optional caption describing the screenshot.
path (required) Uploaded File The screenshot to upload.

Errors

Examples

application/vnd.reviewboard.org.draft-screenshots+json

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

application/vnd.reviewboard.org.draft-screenshots+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <total_results>1</total_results>
 <stat>ok</stat>
 <draft_screenshots>
  <array>
   <item>
    <links>
     <self>
      <href>http://reviews.example.com/api/review-requests/8/draft/screenshots/1/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/review-requests/8/draft/screenshots/1/</href>
      <method>PUT</method>
     </update>
     <delete>
      <href>http://reviews.example.com/api/review-requests/8/draft/screenshots/1/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <url>/media/uploaded/images/2010/08/13/screenshot1.png</url>
    <caption>Example Screenshot</caption>
    <thumbnail_url>/media/uploaded/images/2010/08/13/screenshot1_400x100.png</thumbnail_url>
    <path>uploaded/images/2010/08/13/screenshot1.png</path>
    <id>1</id>
   </item>
  </array>
 </draft_screenshots>
 <links>
  <self>
   <href>http://reviews.example.com/api/review-requests/8/draft/screenshots/</href>
   <method>GET</method>
  </self>
  <create>
   <href>http://reviews.example.com/api/review-requests/8/draft/screenshots/</href>
   <method>POST</method>
  </create>
 </links>
</rsp>