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	Change Resource

Links¶

Name	Method	Resource
self	GET	Change List Resource

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

Examples¶

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

$ curl https://reviews.example.com/api/review-requests/10/changes/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 1118
Content-Type: application/vnd.reviewboard.org.review-request-changes+json
ETag: 62046d02edddaeea2200c6312d6e88d4ec3653a2
Item-Content-Type: application/vnd.reviewboard.org.review-request-change+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "changes": [
    {
      "fields_changed": {
        "diff": {
          "added": {
            "base_commit_id": "1baa5285167980271becd922acd77a20a20b916b", 
            "basedir": "", 
            "commit_count": 2, 
            "extra_data": {}, 
            "id": 14, 
            "links": {
              "commits": {
                "href": "https://reviews.example.com/api/review-requests/10/diffs/2/commits/", 
                "method": "GET"
              }, 
              "files": {
                "href": "https://reviews.example.com/api/review-requests/10/diffs/2/files/", 
                "method": "GET"
              }, 
              "repository": {
                "href": "https://reviews.example.com/api/repositories/3/", 
                "method": "GET", 
                "title": "Git Repo"
              }, 
              "self": {
                "href": "https://reviews.example.com/api/review-requests/10/diffs/2/", 
                "method": "GET"
              }, 
              "update": {
                "href": "https://reviews.example.com/api/review-requests/10/diffs/2/", 
                "method": "PUT"
              }
            }, 
            "name": "diff", 
            "revision": 2, 
            "timestamp": "2018-08-10T22:16:47Z"
          }
        }
      }, 
      "id": 4, 
      "links": {
        "self": {
          "href": "https://reviews.example.com/api/review-requests/10/changes/4/", 
          "method": "GET"
        }
      }, 
      "text": "", 
      "text_type": "plain", 
      "timestamp": "2018-08-10T22:16:47Z"
    }
  ], 
  "links": {
    "self": {
      "href": "https://reviews.example.com/api/review-requests/10/changes/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 1
}