New in version 1.6.
Change List Resource¶
Name | changes |
URI | /api/review-requests/{review_request_id}/changes/ |
Description | 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. For summary, description, testing_done and branch fields, the following detail keys will be available:
For diff fields:
For bugs_closed fields:
For file_attachments, screenshots, target_people and target_groups fields:
For screenshot_captions and file_captions fields:
|
HTTP Methods |
|
Parent Resource | Review Request Resource |
Child Resources | |
Anonymous Access | Yes, if anonymous site access is enabled |
Links¶
Name | Method | Resource |
---|---|---|
self | GET | Change List Resource |
HTTP GET¶
Returns a list of changes made on a review request.
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¶
Examples¶
application/vnd.reviewboard.org.review-request-changes+json¶
{
"changes": [
{
"fields_changed": {
"diff": {
"added": {
"base_commit_id": null,
"basedir": "",
"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"
}
},
"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.",
"timestamp": "2009-02-25T22:32:13Z"
},
{
"fields_changed": {
"diff": {
"added": {
"base_commit_id": null,
"basedir": "",
"id": 10,
"links": {
"files": {
"href": "http://reviews.example.com/api/review-requests/8/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/diffs/2/",
"method": "GET"
}
},
"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.",
"timestamp": "2009-02-25T02:03:18Z"
}
],
"links": {
"self": {
"href": "http://reviews.example.com/api/review-requests/8/changes/",
"method": "GET"
}
},
"stat": "ok",
"total_results": 2
}
application/vnd.reviewboard.org.review-request-changes+xml¶
<?xml version="1.0" encoding="utf-8"?>
<rsp>
<total_results>2</total_results>
<stat>ok</stat>
<changes>
<array>
<item>
<fields_changed>
<diff>
<added>
<base_commit_id>
</base_commit_id>
<links>
<files>
<href>http://reviews.example.com/api/review-requests/8/diffs/3/files/</href>
<method>GET</method>
</files>
<self>
<href>http://reviews.example.com/api/review-requests/8/diffs/3/</href>
<method>GET</method>
</self>
<repository>
<href>http://reviews.example.com/api/repositories/1/</href>
<method>GET</method>
<title>Review Board SVN</title>
</repository>
</links>
<timestamp>2009-02-25T21:39:42Z</timestamp>
<basedir></basedir>
<revision>3</revision>
<id>11</id>
<name>diff</name>
</added>
</diff>
</fields_changed>
<text>Added a diff containing a new file.</text>
<id>2</id>
<links>
<self>
<href>http://reviews.example.com/api/review-requests/8/changes/2/</href>
<method>GET</method>
</self>
</links>
<timestamp>2009-02-25T22:32:13Z</timestamp>
</item>
<item>
<fields_changed>
<diff>
<added>
<base_commit_id>
</base_commit_id>
<links>
<files>
<href>http://reviews.example.com/api/review-requests/8/diffs/2/files/</href>
<method>GET</method>
</files>
<self>
<href>http://reviews.example.com/api/review-requests/8/diffs/2/</href>
<method>GET</method>
</self>
<repository>
<href>http://reviews.example.com/api/repositories/1/</href>
<method>GET</method>
<title>Review Board SVN</title>
</repository>
</links>
<timestamp>2009-02-25T02:03:05Z</timestamp>
<basedir></basedir>
<revision>2</revision>
<id>10</id>
<name>diff</name>
</added>
</diff>
</fields_changed>
<text>Added a second diff for the interdiff test.</text>
<id>1</id>
<links>
<self>
<href>http://reviews.example.com/api/review-requests/8/changes/1/</href>
<method>GET</method>
</self>
</links>
<timestamp>2009-02-25T02:03:18Z</timestamp>
</item>
</array>
</changes>
<links>
<self>
<href>http://reviews.example.com/api/review-requests/8/changes/</href>
<method>GET</method>
</self>
</links>
</rsp>