Jump to >

New in version 1.6.

Change Resource

Name change
URI /api/review-requests/{review_request_id}/changes/{change_id}/
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:

  • old: The old value of the field.
  • new: The new value of the field.

For diff fields:

  • added: The diff that was added.

For bugs_closed fields:

  • old: A list of old bugs.
  • new: A list of new bugs.
  • removed: A list of bugs that were removed, if any.
  • added: A list of bugs that were added, if any.

For file_attachments, screenshots, target_people and target_groups fields:

  • old: A list of old items.
  • new: A list of new items.
  • removed: A list of items that were removed, if any.
  • added: A list of items that were added, if any.

For screenshot_captions fields:

  • old: The old caption.
  • new: The new caption.
  • screenshot: The screenshot that was updated.
HTTP Methods
  • GET - Returns the information on a change to a review request.
Parent Resource Change List Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

Fields

Field Type Description
fields_changed Dictionary The fields that were changed.
id Integer The numeric ID of the change description.
text String The description of the change written by the submitter.
timestamp String The date and time that the change was made (in YYYY-MM-DD HH:MM:SS format).

HTTP GET

Returns the information on a change to a review request.

Examples

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

{
  "change": {
    "fields_changed": {
      "diff": {
        "added": {
          "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-25 21:39:42"
        }
      }
    }, 
    "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-25 22:32:13"
  }, 
  "stat": "ok"
}

application/vnd.reviewboard.org.review-request-change+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <change>
  <fields_changed>
   <diff>
    <added>
     <timestamp>2009-02-25 21:39:42</timestamp>
     <name>diff</name>
     <id>11</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>
     <revision>3</revision>
    </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-25 22:32:13</timestamp>
 </change>
</rsp>