Jump to >

Change List Resource

Added in 1.6

Provides information on a change made to a public review request.

A change includes, optionally, text entered by the user describing the change, and also includes a list of fields that were changed on the review request.

The list of fields changed are in fields_changed. The keys are the names of the fields, and the values are details on that particular change to the field.

Details

Name changes
URI /api/review-requests/{review_request_id}/changes/
Token Policy ID change
HTTP Methods
  • GET - Returns a list of changes made on a review request.
Parent Resource Review Request Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Returns a list of changes made on a 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

Examples

application/vnd.reviewboard.org.review-request-changes+json

$ curl http://reviews.example.com/api/review-requests/8/changes/ -H "Accept: application/json"
Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.review-request-change+json
Content-Type: application/vnd.reviewboard.org.review-request-changes+json
X-Content-Type-Options: nosniff
{
  "changes": [
    {
      "fields_changed": {
        "diff": {
          "added": {
            "base_commit_id": null, 
            "basedir": "", 
            "extra_data": {}, 
            "id": 11, 
            "links": {
              "files": {
                "href": "http://reviews.example.com/api/review-requests/8/diffs/3/files/", 
                "method": "GET"
              }, 
              "repository": {
                "href": "http://reviews.example.com/api/repositories/1/", 
                "method": "GET", 
                "title": "Review Board SVN"
              }, 
              "self": {
                "href": "http://reviews.example.com/api/review-requests/8/diffs/3/", 
                "method": "GET"
              }, 
              "update": {
                "href": "http://reviews.example.com/api/review-requests/8/diffs/3/", 
                "method": "PUT"
              }
            }, 
            "name": "diff", 
            "revision": 3, 
            "timestamp": "2009-02-25T21:39:42Z"
          }
        }
      }, 
      "id": 2, 
      "links": {
        "self": {
          "href": "http://reviews.example.com/api/review-requests/8/changes/2/", 
          "method": "GET"
        }
      }, 
      "text": "Added a diff containing a new file.", 
      "text_type": "plain", 
      "timestamp": "2013-08-07T22:32:13Z"
    }, 
    {
      "fields_changed": {
        "diff": {
          "added": {
            "base_commit_id": null, 
            "basedir": "", 
            "extra_data": {}, 
            "id": 10, 
            "links": {
              "draft_files": {
                "href": "http://reviews.example.com/api/review-requests/8/draft/diffs/2/files/", 
                "method": "GET"
              }, 
              "repository": {
                "href": "http://reviews.example.com/api/repositories/1/", 
                "method": "GET", 
                "title": "Review Board SVN"
              }, 
              "self": {
                "href": "http://reviews.example.com/api/review-requests/8/draft/diffs/2/", 
                "method": "GET"
              }, 
              "update": {
                "href": "http://reviews.example.com/api/review-requests/8/draft/diffs/2/", 
                "method": "PUT"
              }
            }, 
            "name": "diff", 
            "revision": 2, 
            "timestamp": "2009-02-25T02:03:05Z"
          }
        }
      }, 
      "id": 1, 
      "links": {
        "self": {
          "href": "http://reviews.example.com/api/review-requests/8/changes/1/", 
          "method": "GET"
        }
      }, 
      "text": "Added a second diff for the interdiff test.", 
      "text_type": "plain", 
      "timestamp": "2013-08-07T02:03:18Z"
    }
  ], 
  "links": {
    "self": {
      "href": "http://reviews.example.com/api/review-requests/8/changes/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 2
}