Jump to >

This documentation covers the in-development release of Review Board. You can see the latest stable docs or all previous versions.

Draft File Diff List Resource

Added in 2.0

Provides information on per-file diffs that are part of a draft.

Each of these contains a single, self-contained diff file that applies to exactly one file on a repository.


Name draft_files
URI /api/review-requests/{review_request_id}/draft/diffs/{diff_revision}/files/
Token Policy ID draft_file_diff
HTTP Methods
  • GET - Returns the list of draft per-file diffs on the review request.
Parent Resource Draft Diff Resource
Child Resources
Anonymous Access No


Returns the list of draft per-file diffs on the review request.

Each per-file diff has information about the diff. It does not provide the contents of the diff. For that, access the per-file diff’s resource directly and use the correct mimetype.

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.


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.



$ curl http://reviews.example.com/api10/3/ -H "Accept: application/json"
Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.file+json
Content-Type: application/vnd.reviewboard.org.files+json
ETag: 310bfb0987bc6b757f6b89c4a5c9c2ecb86a81a7
X-Content-Type-Options: nosniff
  "files": [], 
  "links": {
    "self": {
      "href": "http://reviews.example.com/api10/3/", 
      "method": "GET"
  "stat": "ok", 
  "total_results": 0