• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Board 7.x
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Web API Guide
    14. Resources
    15. Root List Resource
    16. Review Request List Resource
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • Review Board Workflows
  • Account Settings
  • Dashboard
  • Working with Review Requests
  • Overview
  • Creating Review Requests
  • Editing Fields
  • Uploading Diffs
  • Uploading File Attachments
  • Publishing Review Requests
  • Closing Review Requests
  • Reviewing
  • Reviews and Comments
  • The Review Banner
  • Managing and Publishing Drafts
  • Issue Tracking
  • Reviewing Code (Diffs)
  • Reviewing File Attachments
  • Reviewing Images
  • Reviewing Markdown Files
  • Reviewing Text Files
  • Creating and Editing Reviews
  • Approving Changes (Ship It!)
  • Replying to Comments
  • Automated Code Reviews
  • Searching
  • Quick Search
  • Full-Text Search
  • Using Markdown
  • Administration Guide
  • Installation
  • Installing Review Board
  • Linux System Compatibility
  • Installing with Docker
  • Manually Installing on Linux
  • Installing on macOS
  • Installing on Windows
  • Installing Development Releases
  • Creating a Review Board Site
  • Upgrading
  • Upgrading Review Board
  • Upgrading Review Board Sites
  • Optimization
  • Optimizing and Scaling Review Board
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Configuration
  • Site Settings
  • General Settings
  • Authentication Settings
  • Avatar Services Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • SSH Settings
  • File Storage Settings
  • User Privacy Settings
  • Search Settings
  • Access Control
  • Working with E-Mail
  • Default Reviewers
  • Permission Groups
  • Repositories
  • Bazaar Repositories
  • CVS Repositories
  • Git Repositories
  • HCL VersionVault and IBM ClearCase
  • Mercurial Repositories
  • Perforce Repositories
  • Subversion Repositories
  • Assembla Repositories
  • AWS CodeCommit Repositories
  • Beanstalk Repositories
  • Bitbucket Repositories
  • Bitbucket Server Repositories
  • Codebase HQ Repositories
  • Fedora Hosted Repositories
  • Gerrit Repositories
  • GitHub Repositories
  • GitHub Enterprise Repositories
  • GitLab Repositories
  • Gitorious Repositories
  • Cliosoft SOS Repositories
  • SourceForge Repositories
  • Unfuddle STACK Repositories
  • VisualStudio.com Repositories
  • Review Groups
  • Users
  • WebHooks
  • Extensions
  • Integrations
  • Asana Integration
  • CircleCI Integration
  • Discord Integration
  • I Done This Integration
  • Jenkins CI Integration
  • Matrix Integration
  • Mattermost Integration
  • Microsoft Teams Integration
  • Slack Integration
  • Travis CI Integration
  • Trello Integration
  • Site Maintenance
  • The rb-site Tool
  • Advanced Management Commands
  • Monitoring Review Board
  • Health Checks
  • Web API Guide
  • Resource Tree
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • 219 - Diff Empty
  • 220 - Diff Too Big
  • 221 - File Retrieval Error
  • 222 - Hosting Service Authentication Error
  • 223 - Group Already Exists
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • REST API 2.0
  • Overview
  • Authenticating
  • API Token Policies
  • OAuth2 Authentication
  • Rich Text Fields and Types
  • Storing/Accessing Extra Data
  • Resources
  • Root List Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Extension List Resource
  • Extension Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Root Review List Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • File Diff List Resource
  • Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Commit List Resource
  • Diff Commit Resource
  • Diff Commit Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Diff File Attachment Resource
  • Original File Resource
  • Patched File Resource
  • Extension List Resource
  • Extension Resource
  • Extension Resource
  • Hosting Service List Resource
  • Hosting Service Resource
  • Hosting Service Resource
  • Hosting Service Account List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Hosting Service Account Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository List Resource
  • Remote Repository Resource
  • Remote Repository Resource
  • OAuth2 Applications List Resource
  • OAuth2 Applications Resource
  • OAuth2 Applications Resource
  • OAuth2 Tokens List Resource
  • OAuth2 Tokens Resource
  • OAuth2 Tokens Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Group List Resource
  • Repository Group Resource
  • Repository Group Resource
  • Repository Info Resource
  • Repository User List Resource
  • Repository User Resource
  • Repository User Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User List Resource
  • Review Group User Resource
  • Review Group User Resource
  • Change List Resource
  • Change Resource
  • Change Resource
  • File Attachment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Resource
  • File Attachment Comment List Resource
  • File Attachment Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File Resource
  • File Diff Comment List Resource
  • Review Request List Resource
  • Review Request Resource
  • Change List Resource
  • Diff Context Resource
  • Diff List Resource
  • File Attachment List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Status Update List Resource
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Attachment List Resource
  • File Attachment Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft File Attachment List Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Status Update List Resource
  • Status Update Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Comment List Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft File Diff List Resource
  • Draft Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Commit List Resource
  • Draft Diff Commit Resource
  • Draft Diff Commit Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft File Attachment Resource
  • Draft Original File Resource
  • Draft Patched File Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • Review Request Draft Resource
  • Draft Diff List Resource
  • Draft Diff Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Root Review List Resource
  • Root Diff Comment List Resource
  • Root File Attachment Comment List Resource
  • Root General Comment List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment Comment List Resource
  • Review General Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review File Attachment Comment List Resource
  • Review File Attachment Comment Resource
  • Review File Attachment Comment Resource
  • Review General Comment List Resource
  • Review General Comment Resource
  • Review General Comment Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply General Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply File Attachment Comment List Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply File Attachment Comment Resource
  • Review Reply General Comment List Resource
  • Review Reply General Comment Resource
  • Review Reply General Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Status Update List Resource
  • Status Update Resource
  • Status Update Resource
  • API Token List Resource
  • API Token Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • Muted Review Request Resource
  • Session Resource
  • User List Resource
  • User Resource
  • API Token List Resource
  • Archived Review Request List Resource
  • Muted Review Request List Resource
  • User File Attachment List Resource
  • Watched List Resource
  • User Resource
  • API Token List Resource
  • API Token Resource
  • Archived Review Request List Resource
  • Archived Review Request Resource
  • Muted Review Request List Resource
  • Muted Review Request Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User File Attachment List Resource
  • User File Attachment Resource
  • User File Attachment Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • Validate Diff List Resource
  • Validate Diff Commit List Resource
  • WebHook List Resource
  • WebHook Resource
  • WebHook Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 102 - Invalid Attribute
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 106 - Missing Attribute
  • 107 - Enable Extension Failed
  • 108 - Disable Extension Failed
  • 109 - Extension Already Installed
  • 110 - Install Extension Failed
  • 111 - Duplicate Item
  • 112 - OAuth2 Missing Scope Error
  • 113 - OAuth2 Access Denied Error
  • 114 - Rate Limit Exceeded
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • 219 - Diff Empty
  • 220 - Diff Too Big
  • 221 - File Retrieval Error
  • 222 - Hosting Service Authentication Error
  • 223 - Group Already Exists
  • 224 - Diff Parse Error
  • 225 - Publish Error
  • 226 - User Query Error
  • 227 - Commit ID Already Exists
  • 228 - Token Generation Failed
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • 232 - Ship-It Revocation Error
  • Glossary
  • Extending Review Board
  • Extension Files/Package Layout
  • Creating an Extension Class
  • Extension Configuration
  • Database Models
  • Extension Static Media Files
  • JavaScript Extensions
  • Testing Extensions
  • Extension Distribution
  • Writing Review Board Extensions
  • The rbext Tool
  • Extension Hooks
  • AccountPageFormsHook
  • AccountPagesHook
  • Action Hooks
  • AdminWidgetHook
  • APIExtraDataAccessHook
  • AuthBackendHook
  • AvatarServiceHook
  • CommentDetailDisplayHook
  • DashboardColumnsHook
  • DashboardSidebarItemsHook
  • DataGridColumnsHook
  • EmailHook
  • ReviewRequestPublishedEmailHook
  • ReviewRequestClosedEmailHook
  • ReviewPublishedEmailHook
  • ReviewReplyPublishedEmailHook
  • FileAttachmentThumbnailHook
  • FileDiffACLHook
  • HostingServiceHook
  • IntegrationHook
  • NavigationBarHook
  • ReviewRequestApprovalHook
  • ReviewRequestFieldsHook
  • ReviewRequestFieldSetsHook
  • ReviewUIHook
  • SCMToolHook
  • SignalHook
  • TemplateHook
  • URLHook
  • UserInfoboxHook
  • UserPageSidebarItemsHook
  • WebAPICapabilitiesHook
  • JavaScript Extension Hooks
  • CommentDialogHook
  • FileAttachmentThumbnailContainerHook
  • ReviewDialogCommentHook
  • ReviewDialogHook
  • Adding Review Request Fields
  • Review UI Integration
  • Writing Authentication Backends
  • Writing Legacy Authentication Backends
  • Extending the Web API
  • Module and Class References
  • reviewboard
  • reviewboard.deprecation
  • reviewboard.rb_platform
  • reviewboard.signals
  • reviewboard.accounts.backends
  • reviewboard.accounts.backends.ad
  • reviewboard.accounts.backends.base
  • reviewboard.accounts.backends.http_digest
  • reviewboard.accounts.backends.ldap
  • reviewboard.accounts.backends.nis
  • reviewboard.accounts.backends.registry
  • reviewboard.accounts.backends.standard
  • reviewboard.accounts.backends.x509
  • reviewboard.accounts.decorators
  • reviewboard.accounts.errors
  • reviewboard.accounts.forms.auth
  • reviewboard.accounts.forms.pages
  • reviewboard.accounts.forms.registration
  • reviewboard.accounts.managers
  • reviewboard.accounts.middleware
  • reviewboard.accounts.mixins
  • reviewboard.accounts.models
  • reviewboard.accounts.pages
  • reviewboard.accounts.privacy
  • reviewboard.accounts.templatetags.accounts
  • reviewboard.accounts.testing
  • reviewboard.accounts.testing.queries
  • reviewboard.accounts.trophies
  • reviewboard.actions
  • reviewboard.actions.base
  • reviewboard.actions.errors
  • reviewboard.actions.registry
  • reviewboard.admin
  • reviewboard.admin.admin_sites
  • reviewboard.admin.cache_stats
  • reviewboard.admin.checks
  • reviewboard.admin.decorators
  • reviewboard.admin.form_widgets
  • reviewboard.admin.middleware
  • reviewboard.admin.model_admin
  • reviewboard.admin.security_checks
  • reviewboard.admin.server
  • reviewboard.admin.siteconfig
  • reviewboard.admin.support
  • reviewboard.admin.validation
  • reviewboard.admin.widgets
  • reviewboard.attachments.errors
  • reviewboard.attachments.forms
  • reviewboard.attachments.managers
  • reviewboard.attachments.mimetypes
  • reviewboard.attachments.models
  • reviewboard.avatars.registry
  • reviewboard.avatars.services
  • reviewboard.avatars.settings
  • reviewboard.avatars.templatetags.avatars
  • reviewboard.avatars.testcase
  • reviewboard.changedescs.models
  • reviewboard.datagrids.columns
  • reviewboard.datagrids.grids
  • reviewboard.datagrids.sidebar
  • reviewboard.diffviewer.chunk_generator
  • reviewboard.diffviewer.differ
  • reviewboard.diffviewer.diffutils
  • reviewboard.diffviewer.errors
  • reviewboard.diffviewer.forms
  • reviewboard.diffviewer.managers
  • reviewboard.diffviewer.models
  • reviewboard.diffviewer.models.diffcommit
  • reviewboard.diffviewer.models.diffset
  • reviewboard.diffviewer.models.diffset_history
  • reviewboard.diffviewer.models.filediff
  • reviewboard.diffviewer.models.legacy_file_diff_data
  • reviewboard.diffviewer.models.raw_file_diff_data
  • reviewboard.diffviewer.myersdiff
  • reviewboard.diffviewer.opcode_generator
  • reviewboard.diffviewer.parser
  • reviewboard.diffviewer.processors
  • reviewboard.diffviewer.renderers
  • reviewboard.diffviewer.smdiff
  • reviewboard.certs
  • reviewboard.certs.cert
  • reviewboard.certs.errors
  • reviewboard.extensions.base
  • reviewboard.extensions.hooks
  • reviewboard.extensions.packaging
  • reviewboard.extensions.testing
  • reviewboard.extensions.testing.testcases
  • reviewboard.hostingsvcs.base
  • reviewboard.hostingsvcs.base.client
  • reviewboard.hostingsvcs.base.forms
  • reviewboard.hostingsvcs.base.hosting_service
  • reviewboard.hostingsvcs.base.http
  • reviewboard.hostingsvcs.base.paginator
  • reviewboard.hostingsvcs.base.registry
  • reviewboard.hostingsvcs.base.repository
  • reviewboard.hostingsvcs.errors
  • reviewboard.hostingsvcs.forms
  • reviewboard.hostingsvcs.hook_utils
  • reviewboard.hostingsvcs.models
  • reviewboard.hostingsvcs.repository
  • reviewboard.hostingsvcs.service
  • reviewboard.hostingsvcs.testing
  • reviewboard.hostingsvcs.testing.testcases
  • reviewboard.hostingsvcs.utils.paginator
  • reviewboard.integrations
  • reviewboard.integrations.base
  • reviewboard.integrations.forms
  • reviewboard.integrations.models
  • reviewboard.integrations.urls
  • reviewboard.integrations.views
  • reviewboard.notifications
  • reviewboard.notifications.email
  • reviewboard.notifications.email.backend
  • reviewboard.notifications.email.decorators
  • reviewboard.notifications.email.hooks
  • reviewboard.notifications.email.message
  • reviewboard.notifications.email.utils
  • reviewboard.notifications.email.views
  • reviewboard.notifications.forms
  • reviewboard.notifications.managers
  • reviewboard.notifications.models
  • reviewboard.notifications.webhooks
  • reviewboard.reviews.actions
  • reviewboard.reviews.builtin_fields
  • reviewboard.reviews.chunk_generators
  • reviewboard.reviews.conditions
  • reviewboard.reviews.context
  • reviewboard.reviews.default_actions
  • reviewboard.reviews.detail
  • reviewboard.reviews.errors
  • reviewboard.reviews.features
  • reviewboard.reviews.fields
  • reviewboard.reviews.forms
  • reviewboard.reviews.managers
  • reviewboard.reviews.markdown_utils
  • reviewboard.reviews.models
  • reviewboard.reviews.signals
  • reviewboard.reviews.templatetags.reviewtags
  • reviewboard.reviews.testing
  • reviewboard.reviews.testing.queries
  • reviewboard.reviews.testing.queries.review_groups
  • reviewboard.reviews.testing.queries.review_requests
  • reviewboard.reviews.testing.queries.reviews
  • reviewboard.reviews.ui.base
  • reviewboard.reviews.ui.image
  • reviewboard.reviews.ui.markdownui
  • reviewboard.reviews.ui.text
  • reviewboard.reviews.views.attachments
  • reviewboard.reviews.views.bug_trackers
  • reviewboard.reviews.views.diff_fragments
  • reviewboard.reviews.views.diffviewer
  • reviewboard.reviews.views.download_diff
  • reviewboard.reviews.views.email
  • reviewboard.reviews.views.mixins
  • reviewboard.reviews.views.new_review_request
  • reviewboard.reviews.views.review_request_detail
  • reviewboard.reviews.views.review_request_infobox
  • reviewboard.reviews.views.review_request_updates
  • reviewboard.reviews.views.root
  • reviewboard.scmtools.certs
  • reviewboard.scmtools.conditions
  • reviewboard.scmtools.core
  • reviewboard.scmtools.crypto_utils
  • reviewboard.scmtools.errors
  • reviewboard.scmtools.forms
  • reviewboard.scmtools.managers
  • reviewboard.scmtools.models
  • reviewboard.scmtools.signals
  • reviewboard.scmtools.testing
  • reviewboard.scmtools.testing.queries
  • reviewboard.scmtools.tests.testcases
  • reviewboard.search.fields
  • reviewboard.search.forms
  • reviewboard.search.indexes
  • reviewboard.search.search_backends.base
  • reviewboard.search.search_backends.elasticsearch
  • reviewboard.search.search_backends.registry
  • reviewboard.search.search_backends.whoosh
  • reviewboard.search.signal_processor
  • reviewboard.search.testing
  • reviewboard.site.conditions
  • reviewboard.site.context_processors
  • reviewboard.site.decorators
  • reviewboard.site.middleware
  • reviewboard.site.mixins
  • reviewboard.site.models
  • reviewboard.site.signals
  • reviewboard.site.templatetags.localsite
  • reviewboard.site.testing
  • reviewboard.site.testing.queries
  • reviewboard.site.urlresolvers
  • reviewboard.site.validation
  • reviewboard.ssh.client
  • reviewboard.ssh.errors
  • reviewboard.ssh.policy
  • reviewboard.ssh.storage
  • reviewboard.ssh.utils
  • reviewboard.testing.hosting_services
  • reviewboard.testing.queries
  • reviewboard.testing.queries.base
  • reviewboard.testing.queries.http
  • reviewboard.testing.scmtool
  • reviewboard.testing.testcase
  • reviewboard.themes
  • reviewboard.themes.context_processors
  • reviewboard.themes.ui
  • reviewboard.themes.ui.base
  • reviewboard.themes.ui.default
  • reviewboard.themes.ui.registry
  • reviewboard.webapi.auth_backends
  • reviewboard.webapi.base
  • reviewboard.webapi.decorators
  • reviewboard.webapi.errors
  • reviewboard.webapi.mixins
  • reviewboard.webapi.models
  • reviewboard.webapi.server_info
  • reviewboard.webapi.testing
  • reviewboard.webapi.testing.queries
  • reviewboard.webapi.tests.base
  • Frequently Asked Questions
  • General Index
  • Python Module Index
  • Release Notes
  • Review Request List Resource¶

    Provides information on review requests.

    Review requests are one of the central concepts in Review Board. They represent code or files that are being placed up for review.

    A review request has a number of fields that can be filled out, indicating the summary, description of the change, testing that was done, affected bugs, and more. These must be filled out through the associated Review Request Draft resource.

    When a review request is published, it can be reviewed by users. It can then be updated, again through the Review Request Draft resource, or closed as submitted or discarded.

    Details¶

    Name review_requests
    URI /api/review-requests/
    Token Policy ID review_request
    HTTP Methods
    • GET - Returns all review requests that the user has read access to.

    • POST - Creates a new review request.

    Parent Resource

    Root List Resource

    Child Resources
    • Review Request Resource

    Links¶

    Name

    Method

    Resource

    create

    POST

    Review Request List Resource

    self

    GET

    Review Request List Resource

    HTTP GET¶

    Returns all review requests that the user has read access to.

    By default, this returns all published or formerly published review requests.

    The resulting list can be filtered down through the many request parameters.

    Request Parameters¶

    branchString

    The branch field on a review request to filter by.

    Added in 3.0.16

    changenumInteger

    The change number the review requests must have set. This will only return one review request per repository, and only works for repository types that support server-side changesets. This is deprecated in favor of the commit_id field.

    commit-idString

    The commit that review requests must have set. This will only return one review request per repository.

    This obsoletes the changenum field.

    Added in 2.0

    counts-onlyBoolean

    If specified, a single count field is returned with the number of results, instead of the results themselves.

    from-userString

    The username that the review requests must be owned by.

    issue-dropped-countInteger

    The review request must have exactly the provided number of dropped issues.

    Added in 2.0

    issue-dropped-count-gtInteger

    The review request must have more than the provided number of dropped issues.

    Added in 2.0

    issue-dropped-count-gteInteger

    The review request must have at least the provided number of dropped issues.

    Added in 2.0

    issue-dropped-count-ltInteger

    The review request must have less than the provided number of dropped issues.

    Added in 2.0

    issue-dropped-count-lteInteger

    The review request must have at most the provided number of dropped issues.

    Added in 2.0

    issue-open-countInteger

    The review request must have exactly the provided number of open issues.

    Added in 2.0

    issue-open-count-gtInteger

    The review request must have more than the provided number of open issues.

    Added in 2.0

    issue-open-count-gteInteger

    The review request must have at least the provided number of open issues.

    Added in 2.0

    issue-open-count-ltInteger

    The review request must have less than the provided number of open issues.

    Added in 2.0

    issue-open-count-lteInteger

    The review request must have at most the provided number of open issues.

    Added in 2.0

    issue-resolved-countInteger

    The review request must have exactly the provided number of resolved issues.

    Added in 2.0

    issue-resolved-count-gtInteger

    The review request must have more than the provided number of resolved issues.

    Added in 2.0

    issue-resolved-count-gteInteger

    The review request must have at least the provided number of resolved issues.

    Added in 2.0

    issue-resolved-count-ltInteger

    The review request must have less than the provided number of resolved issues.

    Added in 2.0

    issue-resolved-count-lteInteger

    The review request must have at most the provided number of resolved issues.

    Added in 2.0

    last-updated-from

    ISO 8601 Date/Time

    The earliest date/time the review request could be last updated. This is compared against the review request’s last_updated field. This must be a valid date/time format.

    last-updated-to

    ISO 8601 Date/Time

    The date/time that all review requests must be last updated before. This is compared against the review request’s last_updated field. This must be a valid date/time format.

    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.

    repositoryInteger

    The ID of the repository that the review requests must be on.

    ship-itBoolean Deprecated

    The review request must have at least one review with Ship It set, if this is 1. Otherwise, if 0, it must not have any marked Ship It.

    Added in 1.6

    Deprecated in 2.0

    ship-it-countInteger

    The review request must have exactly the provided number of Ship Its.

    Added in 2.0

    ship-it-count-gtInteger

    The review request must have more than the provided number of Ship Its.

    Added in 2.0

    ship-it-count-gteInteger

    The review request must have at least the provided number of Ship Its.

    Added in 2.0

    ship-it-count-ltInteger

    The review request must have less than the provided number of Ship Its.

    Added in 2.0

    ship-it-count-lteInteger

    The review request must have at most the provided number of Ship Its.

    Added in 2.0

    show-all-unpublishedBoolean

    If set, and if the user is an admin or has the “reviews.can_submit_as_another_user” permission, unpublished review requests will also be returned.

    Added in 2.0.8

    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.

    statusOne of all, discarded, pending, submitted

    The status of the review requests.

    time-added-from

    ISO 8601 Date/Time

    The earliest date/time the review request could be added. This is compared against the review request’s time_added field. This must be a valid date/time format.

    time-added-to

    ISO 8601 Date/Time

    The date/time that all review requests must be added before. This is compared against the review request’s time_added field. This must be a valid date/time format.

    to-groupsString

    A comma-separated list of review group names that the review requests must have in the reviewer list.

    to-user-groupsString

    A comma-separated list of usernames who are in groups that the review requests must have in the reviewer list.

    to-usersString

    A comma-separated list of usernames that the review requests must either have in the reviewer list specifically or by way of a group.

    to-users-directlyString

    A comma-separated list of usernames that the review requests must have in the reviewer list specifically.

    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.

    HTTP POST¶

    Creates a new review request.

    The new review request will start off as private and pending, and will normally be blank. However, if changenum or both commit_id and create_from_commit_id=1 is passed and the given repository both supports server-side changesets and has changeset support in Review Board, some details (Summary, Description and Testing Done sections, for instance) may be automatically filled in from the server.

    Any new review request will have an associated draft (reachable through the draft link). All the details of the review request must be set through the draft. The new review request will be public when that first draft is published.

    A repository can be passed. This is required for diffs associated with a review request. A valid repository is in the form of a numeric repository ID, the name of a repository, or the path to a repository (matching exactly the registered repository’s Path or Mirror Path fields in the administration interface).

    If a repository is not passed, this review request can only be used for attached files.

    Clients can create review requests on behalf of another user by setting the submit_as parameter to the username of the desired user. This requires that the client is currently logged in as a user that has the reviews.can_submit_as_another_user permission set. This capability is useful when writing automation scripts, such as post-commit hooks, that need to create review requests for another user.

    Extra data can be stored later lookup. See Storing/Accessing Extra Data for more information.

    Request Parameters¶

    changenumInteger Deprecated

    The optional change number to look up for the review request details. This only works with repositories that support server-side changesets.

    This is deprecated in favor of the commit_id field.

    Deprecated in 2.0

    commit_idString

    The optional commit to create the review request for. This should be used in place of the changenum field.

    If create_from_commit_id=1 is passed, then the review request information and diff will be based on this commit ID.

    Added in 2.0

    create_from_commit_idBoolean

    If true, and if commit_id is provided, the review request information and (when supported) the idff will be based on the commit ID.

    This field cannot be set if “create_with_history” is set.

    Added in 2.0

    create_with_historyBoolean

    Whether or not to create the review request with support for history.

    This field cannot be set if “create_from_commit_id” is set.

    Added in 4.0

    force_text_typeOne of plain, markdown, html

    The text type, if any, to force for returned text fields. The contents will be converted to the requested type in the payload, but will not be saved as that type.

    Added in 2.0.9

    repositoryString

    The path or ID of the repository that the review request is for.

    submit_asString

    The optional user to submit the review request as. This requires that the actual logged in user is either a superuser or has the reviews.can_submit_as_another_user permission.

    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.
    203 - Invalid Change NumberHTTP 404 - Not Found The commit ID specified could not be found.
    204 - Change Number In UseHTTP 409 - Conflict The commit ID specified has already been used.
    205 - Missing RepositoryHTTP 400 - Bad Request There was no repository found at the specified path.
    206 - Invalid RepositoryHTTP 400 - Bad Request The repository path specified is not in the list of known repositories.
    208 - Invalid UserHTTP 400 - Bad Request User does not exist.
    210 - Repository Information ErrorHTTP 500 - Internal Server Error There was an error communicating with this repository.
    212 - Empty ChangesetHTTP 400 - Bad Request The commit ID specified represents an empty changeset.
    216 - Unverified Host CertificateHTTP 403 - Forbidden The HTTPS certificate on the host is unverified.
    218 - Repository Authentication ErrorHTTP 403 - Forbidden Unable to authenticate with the repository using the provided credentials.
    219 - Diff EmptyHTTP 400 - Bad Request The specified diff file is empty.
    220 - Diff Too BigHTTP 400 - Bad Request The specified diff file is too large.
    224 - Diff Parse ErrorHTTP 400 - Bad Request The specified diff file could not be parsed.

    Examples¶

    application/vnd.reviewboard.org.review-requests+json¶

    $ curl https://reviews.example.com/api/review-requests/ -H "Accept: application/json"
    
    HTTP 200 OK
    Content-Length: 18285
    Content-Type: application/vnd.reviewboard.org.review-requests+json
    ETag: fe05af6b4896ad6b708cd195566fce359acde88d
    Item-Content-Type: application/vnd.reviewboard.org.review-request+json
    Vary: Accept, Cookie
    X-Content-Type-Options: nosniff
    
    {
      "links": {
        "create": {
          "href": "https://reviews.example.com/api/review-requests/",
          "method": "POST"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/",
          "method": "GET"
        }
      },
      "review_requests": [
        {
          "absolute_url": "https://reviews.example.com/r/10/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "",
          "bugs_closed": [],
          "changenum": null,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": null,
          "created_with_history": true,
          "depends_on": [],
          "description": "Test review request with history.",
          "description_text_type": "markdown",
          "extra_data": {
            "calculated_trophies": true,
            "local_branch": "master"
          },
          "id": 10,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2018-08-10T22:16:47Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/10/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/10/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/10/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/10/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/10/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/10/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/10/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/10/diffs/2/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/3/",
              "method": "GET",
              "title": "Git Repo"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/10/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/10/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/10/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/10/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/doc/",
              "method": "GET",
              "title": "doc"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/10/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Review request with history",
          "target_groups": [
            {
              "href": "https://reviews.example.com/api/groups/devgroup/",
              "method": "GET",
              "title": "devgroup"
            }
          ],
          "target_people": [],
          "testing_done": "",
          "testing_done_text_type": "markdown",
          "text_type": null,
          "time_added": "2018-08-10T22:16:22Z",
          "url": "/r/10/"
        },
        {
          "absolute_url": "https://reviews.example.com/r/8/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "trunk",
          "bugs_closed": [],
          "changenum": null,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": null,
          "created_with_history": false,
          "depends_on": [],
          "description": "This is a test designed for interdiffs.",
          "description_text_type": "plain",
          "extra_data": {},
          "id": 8,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2013-09-07T02:26:18Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/8/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/8/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/8/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/8/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/8/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/8/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/8/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/8/diffs/3/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/1/",
              "method": "GET",
              "title": "Review Board SVN"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/8/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/8/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/8/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/8/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/admin/",
              "method": "GET",
              "title": "admin"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/8/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Interdiff Revision Test",
          "target_groups": [],
          "target_people": [
            {
              "href": "https://reviews.example.com/api/users/grumpy/",
              "method": "GET",
              "title": "grumpy"
            }
          ],
          "testing_done": "",
          "testing_done_text_type": "plain",
          "text_type": null,
          "time_added": "2013-08-07T02:01:21Z",
          "url": "/r/8/"
        },
        {
          "absolute_url": "https://reviews.example.com/r/9/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "",
          "bugs_closed": [],
          "changenum": null,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": "",
          "created_with_history": false,
          "depends_on": [],
          "description": "Just some tests for diff file attachments",
          "description_text_type": "plain",
          "extra_data": {},
          "id": 9,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2013-09-06T20:19:34Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/9/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/9/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/9/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/9/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/9/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/9/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/9/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/9/diffs/1/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/1/",
              "method": "GET",
              "title": "Review Board SVN"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/9/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/9/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/9/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/9/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/doc/",
              "method": "GET",
              "title": "doc"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/9/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Diff file attachments test",
          "target_groups": [
            {
              "href": "https://reviews.example.com/api/groups/devgroup/",
              "method": "GET",
              "title": "devgroup"
            }
          ],
          "target_people": [],
          "testing_done": "",
          "testing_done_text_type": "plain",
          "text_type": null,
          "time_added": "2013-09-06T19:38:35Z",
          "url": "/r/9/"
        },
        {
          "absolute_url": "https://reviews.example.com/r/4/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "",
          "bugs_closed": [
            "12345"
          ],
          "changenum": 1234,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": "1234",
          "created_with_history": false,
          "depends_on": [],
          "description": "Test description.",
          "description_text_type": "plain",
          "extra_data": {},
          "id": 4,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2007-06-24T01:11:24Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/4/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/4/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/4/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/4/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/4/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/4/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/4/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/4/diffs/1/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/1/",
              "method": "GET",
              "title": "Review Board SVN"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/4/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/4/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/4/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/4/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/grumpy/",
              "method": "GET",
              "title": "grumpy"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/4/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Made e-mail improvements",
          "target_groups": [],
          "target_people": [
            {
              "href": "https://reviews.example.com/api/users/doc/",
              "method": "GET",
              "title": "doc"
            }
          ],
          "testing_done": "Tested.",
          "testing_done_text_type": "plain",
          "text_type": null,
          "time_added": "2007-06-24T00:42:42Z",
          "url": "/r/4/"
        },
        {
          "absolute_url": "https://reviews.example.com/r/6/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "trunk",
          "bugs_closed": [],
          "changenum": null,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": null,
          "created_with_history": false,
          "depends_on": [],
          "description": "Foo",
          "description_text_type": "plain",
          "extra_data": {},
          "id": 6,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2007-06-24T01:10:59Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/6/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/6/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/6/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/6/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/6/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/6/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/6/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/6/diffs/1/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/1/",
              "method": "GET",
              "title": "Review Board SVN"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/6/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/6/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/6/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/6/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/dopey/",
              "method": "GET",
              "title": "dopey"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/6/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Error dialog",
          "target_groups": [
            {
              "href": "https://reviews.example.com/api/groups/emptygroup/",
              "method": "GET",
              "title": "emptygroup"
            }
          ],
          "target_people": [],
          "testing_done": "Bar",
          "testing_done_text_type": "plain",
          "text_type": null,
          "time_added": "2007-06-24T00:47:14Z",
          "url": "/r/6/"
        },
        {
          "absolute_url": "https://reviews.example.com/r/2/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "trunk",
          "bugs_closed": [
            "123"
          ],
          "changenum": null,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": null,
          "created_with_history": false,
          "depends_on": [],
          "description": "Be compatible with cleaned_data changes in Django.",
          "description_text_type": "plain",
          "extra_data": {},
          "id": 2,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2007-06-24T00:34:17Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/2/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/2/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/2/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/2/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/2/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/2/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/2/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/2/diffs/1/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/1/",
              "method": "GET",
              "title": "Review Board SVN"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/2/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/2/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/2/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/2/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/dopey/",
              "method": "GET",
              "title": "dopey"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/2/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Update for cleaned_data changes",
          "target_groups": [
            {
              "href": "https://reviews.example.com/api/groups/devgroup/",
              "method": "GET",
              "title": "devgroup"
            }
          ],
          "target_people": [],
          "testing_done": "Works.",
          "testing_done_text_type": "plain",
          "text_type": null,
          "time_added": "2007-06-24T00:14:32Z",
          "url": "/r/2/"
        },
        {
          "absolute_url": "https://reviews.example.com/r/3/",
          "approval_failure": "The review request has not been marked \"Ship It!\"",
          "approved": false,
          "blocks": [],
          "branch": "trunk",
          "bugs_closed": [
            "1234",
            "4321",
            "5678",
            "8765"
          ],
          "changenum": null,
          "close_description": null,
          "close_description_text_type": "plain",
          "commit_id": null,
          "created_with_history": false,
          "depends_on": [],
          "description": "Added some user permissions checking for JSON API functions.",
          "description_text_type": "plain",
          "extra_data": {},
          "id": 3,
          "issue_dropped_count": 0,
          "issue_open_count": 0,
          "issue_resolved_count": 0,
          "issue_verifying_count": 0,
          "last_updated": "2007-06-24T00:28:33Z",
          "links": {
            "changes": {
              "href": "https://reviews.example.com/api/review-requests/3/changes/",
              "method": "GET"
            },
            "delete": {
              "href": "https://reviews.example.com/api/review-requests/3/",
              "method": "DELETE"
            },
            "diff_context": {
              "href": "https://reviews.example.com/api/review-requests/3/diff-context/",
              "method": "GET"
            },
            "diffs": {
              "href": "https://reviews.example.com/api/review-requests/3/diffs/",
              "method": "GET"
            },
            "draft": {
              "href": "https://reviews.example.com/api/review-requests/3/draft/",
              "method": "GET"
            },
            "file_attachments": {
              "href": "https://reviews.example.com/api/review-requests/3/file-attachments/",
              "method": "GET"
            },
            "last_update": {
              "href": "https://reviews.example.com/api/review-requests/3/last-update/",
              "method": "GET"
            },
            "latest_diff": {
              "href": "http://example.com/api/review-requests/3/diffs/1/",
              "method": "GET"
            },
            "repository": {
              "href": "https://reviews.example.com/api/repositories/1/",
              "method": "GET",
              "title": "Review Board SVN"
            },
            "reviews": {
              "href": "https://reviews.example.com/api/review-requests/3/reviews/",
              "method": "GET"
            },
            "screenshots": {
              "href": "https://reviews.example.com/api/review-requests/3/screenshots/",
              "method": "GET"
            },
            "self": {
              "href": "https://reviews.example.com/api/review-requests/3/",
              "method": "GET"
            },
            "status_updates": {
              "href": "https://reviews.example.com/api/review-requests/3/status-updates/",
              "method": "GET"
            },
            "submitter": {
              "href": "https://reviews.example.com/api/users/admin/",
              "method": "GET",
              "title": "admin"
            },
            "update": {
              "href": "https://reviews.example.com/api/review-requests/3/",
              "method": "PUT"
            }
          },
          "public": true,
          "ship_it_count": 0,
          "status": "pending",
          "summary": "Add permission checking for JSON API",
          "target_groups": [
            {
              "href": "https://reviews.example.com/api/groups/privgroup/",
              "method": "GET",
              "title": "privgroup"
            }
          ],
          "target_people": [
            {
              "href": "https://reviews.example.com/api/users/doc/",
              "method": "GET",
              "title": "doc"
            },
            {
              "href": "https://reviews.example.com/api/users/dopey/",
              "method": "GET",
              "title": "dopey"
            }
          ],
          "testing_done": "Tested some functions.",
          "testing_done_text_type": "plain",
          "text_type": null,
          "time_added": "2007-06-24T00:17:33Z",
          "url": "/r/3/"
        }
      ],
      "stat": "ok",
      "total_results": 7
    }
    

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Details
    • Links
    • HTTP GET
      • Request Parameters
      • Errors
    • HTTP POST
      • Request Parameters
      • Errors
    • Examples
      • application/vnd.reviewboard.org.review-requests+json