Jump to >

Diff File Attachment List Resource

Added in 2.0

Provides information on file attachments associated with files in diffs.

The list of file attachments are tied to files either committed to the repository or proposed in diffs to a review request on the repository. All are associated with a file in a diff.

Files that are newly introduced in a diff and do not have a revision as of that diff will have the added_in_filediff link set, and repository_revision will be null.

Details

Name diff_file_attachments
URI /api/repositories/{repository_id}/diff-file-attachments/
Token Policy ID diff_file_attachment
HTTP Methods
  • GET - Returns the list of file attachments associated with diffs.
Parent Resource Repository Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Returns the list of file attachments associated with diffs.

Each item in this list is a file attachment associated with a file or a proposed change against the parent repository. A file attachment may be referenced by one or more diffs.

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.
mimetypeString Filter file attachments with the given mimetype.
repository-file-pathString Filter file attachments with the given path in the repository.
repository-revisionString Filter file attachments for files with the given revision.
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

Examples

application/vnd.reviewboard.org.diff-file-attachments+json

$ curl http://reviews.example.com/api/repositories/1/diff-file-attachments/ -H "Accept: application/json"
Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.diff-file-attachment+json
Content-Type: application/vnd.reviewboard.org.diff-file-attachments+json
X-Content-Type-Options: nosniff
{
  "diff_file_attachments": [
    {
      "absolute_url": "http://example.com/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1.png", 
      "added_in_filediff": null, 
      "attachment_history_id": null, 
      "caption": "Sprite Sheet", 
      "filename": "spritesheet.png", 
      "icon_url": "/static/rb/images/mimetypes/image-x-generic.png", 
      "id": 2, 
      "links": {
        "self": {
          "href": "http://reviews.example.com/api/repositories/1/diff-file-attachments/2/", 
          "method": "GET"
        }
      }, 
      "mimetype": "image/png", 
      "repository_file_path": "/images/spritesheet.png", 
      "repository_revision": "123", 
      "review_url": "", 
      "revision": 0, 
      "thumbnail": "<div class=\"file-thumbnail\"> <img src=\"/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1_300.png\" data-at2x=\"/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1_600.png\" alt=\"Sprite Sheet\" /></div>", 
      "url": "http://example.com/media/uploaded/files/2013/09/06/98e2a2c1-2c97-4d65-af27-d426ca6ae2d3__image1.png"
    }, 
    {
      "absolute_url": "http://example.com/media/uploaded/files/2013/09/06/ddbd9f36-541c-4ee5-8c9d-94566cd83ec0__image1.png", 
      "added_in_filediff": null, 
      "attachment_history_id": null, 
      "caption": "Sprite Sheet", 
      "filename": "spritesheet.png", 
      "icon_url": "/static/rb/images/mimetypes/image-x-generic.png", 
      "id": 3, 
      "links": {
        "self": {
          "href": "http://reviews.example.com/api/repositories/1/diff-file-attachments/3/", 
          "method": "GET"
        }
      }, 
      "mimetype": "image/png", 
      "repository_file_path": "/images/spritesheet.png", 
      "repository_revision": "124", 
      "review_url": "", 
      "revision": 0, 
      "thumbnail": "<div class=\"file-thumbnail\"> <img src=\"\" data-at2x=\"\" alt=\"Sprite Sheet\" /></div>", 
      "url": "http://example.com/media/uploaded/files/2013/09/06/ddbd9f36-541c-4ee5-8c9d-94566cd83ec0__image1.png"
    }, 
    {
      "absolute_url": "http://example.com/media/uploaded/files/2013/09/06/Logo.png", 
      "attachment_history_id": null, 
      "caption": "Logo", 
      "filename": "logo.png", 
      "icon_url": "/static/rb/images/mimetypes/image-x-generic.png", 
      "id": 4, 
      "links": {
        "added_in_filediff": {
          "href": "http://reviews.example.com/api/review-requests/9/diffs/1/files/43/", 
          "method": "GET", 
          "title": "/images/logo.png (PRE-CREATION) -> /images/logo.png (1)"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/repositories/1/diff-file-attachments/4/", 
          "method": "GET"
        }
      }, 
      "mimetype": "image/png", 
      "repository_file_path": "/images/logo.png", 
      "repository_revision": null, 
      "review_url": "", 
      "revision": 0, 
      "thumbnail": "<div class=\"file-thumbnail\"> <img src=\"/media/uploaded/files/2013/09/06/Logo_300.png\" data-at2x=\"/media/uploaded/files/2013/09/06/Logo_600.png\" alt=\"Logo\" /></div>", 
      "url": "http://example.com/media/uploaded/files/2013/09/06/Logo.png"
    }
  ], 
  "links": {
    "self": {
      "href": "http://reviews.example.com/api/repositories/1/diff-file-attachments/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 3
}