This documentation covers the in-development release of Review Board. You can see the latest stable docs or all previous versions.

Root List Resource¶

Name	`root`
URI	`/api/`
Description	Links to all the main resources, including URI templates to resources anywhere in the tree. This should be used as a starting point for any clients that need to access any resources in the API. By browsing through the resource tree instead of hard-coding paths, your client can remain compatible with any changes in the resource URI scheme.
HTTP Methods	GET - Handles HTTP GETs to list resources.
Parent Resource	None.
Child Resources	Repository List Resource Review Group List Resource Review Request List Resource Search Resource Server Info Resource Session Resource User List Resource
Anonymous Access	Yes

Links¶

Name	Method	Resource
extensions	GET	`webapi2.0-extension-list-resource`
groups	GET	Review Group List Resource
info	GET	Server Info Resource
repositories	GET	Repository List Resource
review_requests	GET	Review Request List Resource
search	GET	Search Resource
self	GET	Root List Resource
session	GET	Session Resource
users	GET	User List Resource

HTTP GET¶

Handles HTTP GETs to list resources.

By default, this will query for a list of objects and return the list in a serialized form.

Request Parameters¶

Field	Type	Description
max-results (optional)	Integer	The maximum number of results to return in this list. By default, this is 25.
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.

Examples¶

application/json¶

{
  "links": {
    "extensions": {
      "href": "http://reviews.example.com/api/extensions/", 
      "method": "GET"
    }, 
    "groups": {
      "href": "http://reviews.example.com/api/groups/", 
      "method": "GET"
    }, 
    "info": {
      "href": "http://reviews.example.com/api/info/", 
      "method": "GET"
    }, 
    "repositories": {
      "href": "http://reviews.example.com/api/repositories/", 
      "method": "GET"
    }, 
    "review_requests": {
      "href": "http://reviews.example.com/api/review-requests/", 
      "method": "GET"
    }, 
    "search": {
      "href": "http://reviews.example.com/api/search/", 
      "method": "GET"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/", 
      "method": "GET"
    }, 
    "session": {
      "href": "http://reviews.example.com/api/session/", 
      "method": "GET"
    }, 
    "users": {
      "href": "http://reviews.example.com/api/users/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "uri_templates": {
    "change": "http://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/", 
    "changes": "http://reviews.example.com/api/review-requests/{review_request_id}/changes/", 
    "diff": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/", 
    "diff_comment": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/", 
    "diff_comments": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/", 
    "diffs": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/", 
    "draft": "http://reviews.example.com/api/review-requests/{review_request_id}/draft/", 
    "extension": "http://reviews.example.com/api/extensions/{extension_name}/", 
    "extensions": "http://reviews.example.com/api/extensions/", 
    "file": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/", 
    "file_attachment": "http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/", 
    "file_attachment_comment": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/{comment_id}/", 
    "file_attachment_comments": "http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/file-attachment-comments/", 
    "file_attachments": "http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/", 
    "files": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/", 
    "group": "http://reviews.example.com/api/groups/{group_name}/", 
    "groups": "http://reviews.example.com/api/groups/", 
    "info": "http://reviews.example.com/api/info/", 
    "last_update": "http://reviews.example.com/api/review-requests/{review_request_id}/last-update/", 
    "original_file": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/", 
    "patched_file": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/", 
    "replies": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/", 
    "reply": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/", 
    "reply_draft": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/", 
    "repositories": "http://reviews.example.com/api/repositories/", 
    "repository": "http://reviews.example.com/api/repositories/{repository_id}/", 
    "review": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/", 
    "review_draft": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/", 
    "review_request": "http://reviews.example.com/api/review-requests/{review_request_id}/", 
    "review_requests": "http://reviews.example.com/api/review-requests/", 
    "reviews": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/", 
    "root": "http://reviews.example.com/api/", 
    "screenshot": "http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/", 
    "screenshot_comment": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/", 
    "screenshot_comments": "http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/", 
    "screenshots": "http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/", 
    "search": "http://reviews.example.com/api/search/{username}/", 
    "session": "http://reviews.example.com/api/session/", 
    "user": "http://reviews.example.com/api/users/{username}/", 
    "users": "http://reviews.example.com/api/users/", 
    "watched": "http://reviews.example.com/api/users/{username}/watched/", 
    "watched_review_group": "http://reviews.example.com/api/users/{username}/watched/review-groups/{watched_obj_id}/", 
    "watched_review_groups": "http://reviews.example.com/api/users/{username}/watched/review-groups/", 
    "watched_review_request": "http://reviews.example.com/api/users/{username}/watched/review-requests/{watched_obj_id}/", 
    "watched_review_requests": "http://reviews.example.com/api/users/{username}/watched/review-requests/"
  }
}

application/xml¶

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <uri_templates>
  <diff_comments>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/</diff_comments>
  <watched_review_groups>http://reviews.example.com/api/users/{username}/watched/review-groups/</watched_review_groups>
  <session>http://reviews.example.com/api/session/</session>
  <file_attachments>http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/</file_attachments>
  <file>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/</file>
  <replies>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/</replies>
  <diff>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/</diff>
  <screenshots>http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/</screenshots>
  <patched_file>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/</patched_file>
  <watched_review_request>http://reviews.example.com/api/users/{username}/watched/review-requests/{watched_obj_id}/</watched_review_request>
  <group>http://reviews.example.com/api/groups/{group_name}/</group>
  <screenshot>http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/</screenshot>
  <review>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/</review>
  <watched_review_group>http://reviews.example.com/api/users/{username}/watched/review-groups/{watched_obj_id}/</watched_review_group>
  <last_update>http://reviews.example.com/api/review-requests/{review_request_id}/last-update/</last_update>
  <diff_comment>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/</diff_comment>
  <draft>http://reviews.example.com/api/review-requests/{review_request_id}/draft/</draft>
  <reply>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/</reply>
  <watched_review_requests>http://reviews.example.com/api/users/{username}/watched/review-requests/</watched_review_requests>
  <review_request>http://reviews.example.com/api/review-requests/{review_request_id}/</review_request>
  <files>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/</files>
  <review_draft>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/</review_draft>
  <users>http://reviews.example.com/api/users/</users>
  <repository>http://reviews.example.com/api/repositories/{repository_id}/</repository>
  <file_attachment_comments>http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/file-attachment-comments/</file_attachment_comments>
  <watched>http://reviews.example.com/api/users/{username}/watched/</watched>
  <screenshot_comments>http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/</screenshot_comments>
  <user>http://reviews.example.com/api/users/{username}/</user>
  <groups>http://reviews.example.com/api/groups/</groups>
  <file_attachment>http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/</file_attachment>
  <change>http://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/</change>
  <original_file>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/</original_file>
  <info>http://reviews.example.com/api/info/</info>
  <diffs>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/</diffs>
  <search>http://reviews.example.com/api/search/{username}/</search>
  <screenshot_comment>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/</screenshot_comment>
  <extension>http://reviews.example.com/api/extensions/{extension_name}/</extension>
  <root>http://reviews.example.com/api/</root>
  <review_requests>http://reviews.example.com/api/review-requests/</review_requests>
  <file_attachment_comment>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/{comment_id}/</file_attachment_comment>
  <repositories>http://reviews.example.com/api/repositories/</repositories>
  <reviews>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/</reviews>
  <reply_draft>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/</reply_draft>
  <extensions>http://reviews.example.com/api/extensions/</extensions>
  <changes>http://reviews.example.com/api/review-requests/{review_request_id}/changes/</changes>
 </uri_templates>
 <links>
  <info>
   <href>http://reviews.example.com/api/info/</href>
   <method>GET</method>
  </info>
  <search>
   <href>http://reviews.example.com/api/search/</href>
   <method>GET</method>
  </search>
  <users>
   <href>http://reviews.example.com/api/users/</href>
   <method>GET</method>
  </users>
  <self>
   <href>http://reviews.example.com/api/</href>
   <method>GET</method>
  </self>
  <repositories>
   <href>http://reviews.example.com/api/repositories/</href>
   <method>GET</method>
  </repositories>
  <session>
   <href>http://reviews.example.com/api/session/</href>
   <method>GET</method>
  </session>
  <extensions>
   <href>http://reviews.example.com/api/extensions/</href>
   <method>GET</method>
  </extensions>
  <groups>
   <href>http://reviews.example.com/api/groups/</href>
   <method>GET</method>
  </groups>
  <review_requests>
   <href>http://reviews.example.com/api/review-requests/</href>
   <method>GET</method>
  </review_requests>
 </links>
</rsp>

application/vnd.reviewboard.org.root+json¶

{"stat": "ok", "uri_templates": {"diff_comments": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/", "watched_review_groups": "http://reviews.example.com/api/users/{username}/watched/review-groups/", "session": "http://reviews.example.com/api/session/", "file_attachments": "http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/", "file": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/", "replies": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/", "diff": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/", "screenshots": "http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/", "patched_file": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/", "watched_review_request": "http://reviews.example.com/api/users/{username}/watched/review-requests/{watched_obj_id}/", "group": "http://reviews.example.com/api/groups/{group_name}/", "screenshot": "http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/", "review": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/", "watched_review_group": "http://reviews.example.com/api/users/{username}/watched/review-groups/{watched_obj_id}/", "last_update": "http://reviews.example.com/api/review-requests/{review_request_id}/last-update/", "diff_comment": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/", "draft": "http://reviews.example.com/api/review-requests/{review_request_id}/draft/", "reply": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/", "watched_review_requests": "http://reviews.example.com/api/users/{username}/watched/review-requests/", "review_request": "http://reviews.example.com/api/review-requests/{review_request_id}/", "files": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/", "review_draft": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/", "users": "http://reviews.example.com/api/users/", "repository": "http://reviews.example.com/api/repositories/{repository_id}/", "file_attachment_comments": "http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/file-attachment-comments/", "watched": "http://reviews.example.com/api/users/{username}/watched/", "screenshot_comments": "http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/", "user": "http://reviews.example.com/api/users/{username}/", "groups": "http://reviews.example.com/api/groups/", "file_attachment": "http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/", "change": "http://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/", "original_file": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/", "info": "http://reviews.example.com/api/info/", "diffs": "http://reviews.example.com/api/review-requests/{review_request_id}/diffs/", "search": "http://reviews.example.com/api/search/{username}/", "screenshot_comment": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/", "extension": "http://reviews.example.com/api/extensions/{extension_name}/", "root": "http://reviews.example.com/api/", "review_requests": "http://reviews.example.com/api/review-requests/", "file_attachment_comment": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/{comment_id}/", "repositories": "http://reviews.example.com/api/repositories/", "reviews": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/", "reply_draft": "http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/", "extensions": "http://reviews.example.com/api/extensions/", "changes": "http://reviews.example.com/api/review-requests/{review_request_id}/changes/"}, "links": {"info": {"href": "http://reviews.example.com/api/info/", "method": "GET"}, "search": {"href": "http://reviews.example.com/api/search/", "method": "GET"}, "users": {"href": "http://reviews.example.com/api/users/", "method": "GET"}, "self": {"href": "http://reviews.example.com/api/", "method": "GET"}, "repositories": {"href": "http://reviews.example.com/api/repositories/", "method": "GET"}, "session": {"href": "http://reviews.example.com/api/session/", "method": "GET"}, "extensions": {"href": "http://reviews.example.com/api/extensions/", "method": "GET"}, "groups": {"href": "http://reviews.example.com/api/groups/", "method": "GET"}, "review_requests": {"href": "http://reviews.example.com/api/review-requests/", "method": "GET"}}}

application/vnd.reviewboard.org.root+xml¶

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <uri_templates>
  <diff_comments>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/</diff_comments>
  <watched_review_groups>http://reviews.example.com/api/users/{username}/watched/review-groups/</watched_review_groups>
  <session>http://reviews.example.com/api/session/</session>
  <file_attachments>http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/</file_attachments>
  <file>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/</file>
  <replies>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/</replies>
  <diff>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/</diff>
  <screenshots>http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/</screenshots>
  <patched_file>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/</patched_file>
  <watched_review_request>http://reviews.example.com/api/users/{username}/watched/review-requests/{watched_obj_id}/</watched_review_request>
  <group>http://reviews.example.com/api/groups/{group_name}/</group>
  <screenshot>http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/</screenshot>
  <review>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/</review>
  <watched_review_group>http://reviews.example.com/api/users/{username}/watched/review-groups/{watched_obj_id}/</watched_review_group>
  <last_update>http://reviews.example.com/api/review-requests/{review_request_id}/last-update/</last_update>
  <diff_comment>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/</diff_comment>
  <draft>http://reviews.example.com/api/review-requests/{review_request_id}/draft/</draft>
  <reply>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/</reply>
  <watched_review_requests>http://reviews.example.com/api/users/{username}/watched/review-requests/</watched_review_requests>
  <review_request>http://reviews.example.com/api/review-requests/{review_request_id}/</review_request>
  <files>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/</files>
  <review_draft>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/</review_draft>
  <users>http://reviews.example.com/api/users/</users>
  <repository>http://reviews.example.com/api/repositories/{repository_id}/</repository>
  <file_attachment_comments>http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/file-attachment-comments/</file_attachment_comments>
  <watched>http://reviews.example.com/api/users/{username}/watched/</watched>
  <screenshot_comments>http://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/</screenshot_comments>
  <user>http://reviews.example.com/api/users/{username}/</user>
  <groups>http://reviews.example.com/api/groups/</groups>
  <file_attachment>http://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/</file_attachment>
  <change>http://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/</change>
  <original_file>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/</original_file>
  <info>http://reviews.example.com/api/info/</info>
  <diffs>http://reviews.example.com/api/review-requests/{review_request_id}/diffs/</diffs>
  <search>http://reviews.example.com/api/search/{username}/</search>
  <screenshot_comment>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/</screenshot_comment>
  <extension>http://reviews.example.com/api/extensions/{extension_name}/</extension>
  <root>http://reviews.example.com/api/</root>
  <review_requests>http://reviews.example.com/api/review-requests/</review_requests>
  <file_attachment_comment>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/{comment_id}/</file_attachment_comment>
  <repositories>http://reviews.example.com/api/repositories/</repositories>
  <reviews>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/</reviews>
  <reply_draft>http://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/</reply_draft>
  <extensions>http://reviews.example.com/api/extensions/</extensions>
  <changes>http://reviews.example.com/api/review-requests/{review_request_id}/changes/</changes>
 </uri_templates>
 <links>
  <info>
   <href>http://reviews.example.com/api/info/</href>
   <method>GET</method>
  </info>
  <search>
   <href>http://reviews.example.com/api/search/</href>
   <method>GET</method>
  </search>
  <users>
   <href>http://reviews.example.com/api/users/</href>
   <method>GET</method>
  </users>
  <self>
   <href>http://reviews.example.com/api/</href>
   <method>GET</method>
  </self>
  <repositories>
   <href>http://reviews.example.com/api/repositories/</href>
   <method>GET</method>
  </repositories>
  <session>
   <href>http://reviews.example.com/api/session/</href>
   <method>GET</method>
  </session>
  <extensions>
   <href>http://reviews.example.com/api/extensions/</href>
   <method>GET</method>
  </extensions>
  <groups>
   <href>http://reviews.example.com/api/groups/</href>
   <method>GET</method>
  </groups>
  <review_requests>
   <href>http://reviews.example.com/api/review-requests/</href>
   <method>GET</method>
  </review_requests>
 </links>
</rsp>

Take the pain out of code review

Contents

Browse

You Are Here: