New in version 1.6.

Draft File Attachment List Resource¶

Name	`draft_file_attachments`
URI	`/api/review-requests/{review_request_id}/draft/file-attachments/`
Description	Provides information on new file attachments being added to a draft of a review request. These are files that will be shown once the pending review request draft is published.
HTTP Methods	GET - Returns a list of draft files. POST - Creates a new file from a file attachment.
Parent Resource	Review Request Draft Resource
Child Resources	Draft File Attachment Resource
Anonymous Access	No

Links¶

Name	Method	Resource
create	POST	Draft File Attachment List Resource
self	GET	Draft File Attachment List Resource

HTTP GET¶

Returns a list of draft files.

Each file attachment in this list is an uploaded file attachment that will be shown in the final review request. These may include newly file attachments or files that were already part of the existing review request. In the latter case, existing files 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. 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.
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.

Errors¶

HTTP POST¶

Creates a new file from a file attachment.

This accepts any file type 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 file’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.zip"

<Content here>
-- SoMe BoUnDaRy --

Request Parameters¶

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

Errors¶

Examples¶

application/vnd.reviewboard.org.draft-file-attachments+json¶

{
  "draft_file_attachments": [
    {
      "caption": "Example Attachment", 
      "filename": "screenshot1.png", 
      "icon_url": "/static/rb/images/mimetypes/image-x-generic.png", 
      "id": 1, 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/", 
          "method": "DELETE"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/", 
          "method": "PUT"
        }
      }, 
      "review_url": "/r/8/file/1/", 
      "thumbnail": "<img src=\"/media/uploaded/images/2010/08/13/screenshot1_400x100.png\" class=\"file-thumbnail\" alt=\"Example Attachment\" />", 
      "url": "http://example.com/media/uploaded/images/2010/08/13/screenshot1.png"
    }
  ], 
  "links": {
    "create": {
      "href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/", 
      "method": "POST"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 1
}

application/vnd.reviewboard.org.draft-file-attachments+xml¶

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <total_results>1</total_results>
 <stat>ok</stat>
 <links>
  <self>
   <href>http://reviews.example.com/api/review-requests/8/draft/file-attachments/</href>
   <method>GET</method>
  </self>
  <create>
   <href>http://reviews.example.com/api/review-requests/8/draft/file-attachments/</href>
   <method>POST</method>
  </create>
 </links>
 <draft_file_attachments>
  <array>
   <item>
    <links>
     <self>
      <href>http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/</href>
      <method>PUT</method>
     </update>
     <delete>
      <href>http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <url>http://example.com/media/uploaded/images/2010/08/13/screenshot1.png</url>
    <icon_url>/static/rb/images/mimetypes/image-x-generic.png</icon_url>
    <thumbnail>&lt;img src="/media/uploaded/images/2010/08/13/screenshot1_400x100.png" class="file-thumbnail" alt="Example Attachment" /&gt;</thumbnail>
    <filename>screenshot1.png</filename>
    <caption>Example Attachment</caption>
    <review_url>/r/8/file/1/</review_url>
    <id>1</id>
   </item>
  </array>
 </draft_file_attachments>
</rsp>