• 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 2.0
    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
    17. Review Request Resource
    18. Review Request Draft Resource
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • General Workflow
  • Account Settings
  • Dashboard
  • Working with Review Requests
  • Creating Review Requests
  • Editing Fields
  • Uploading Diffs
  • Uploading File Attachments
  • Publishing Review Requests
  • Closing Review Requests
  • Reviewing
  • Reviewing Diffs
  • Reviewing File Attachments
  • Reviewing Images
  • Reviewing Markdown Files
  • Reviewing Text Files
  • Issue Tracking
  • Review Draft Banner
  • Creating and Editing Reviews
  • Publishing Reviews
  • Approving Changes (Ship It!)
  • Replying to Comments
  • Searching
  • Quick Search
  • Full-Text Search
  • Using Markdown
  • Administration Guide
  • Installation
  • Installing on Linux
  • Installing on Mac OS X Server
  • Installing on Windows
  • Installing Development Releases
  • Creating a Review Board Site
  • Upgrading
  • Upgrading Review Board
  • Upgrading Sites
  • Optimization
  • General Optimization Tips
  • Optimizing Memcached
  • Optimizing MySQL
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Configuration
  • Site Settings
  • General Settings
  • Authentication Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • SSH Settings
  • File Storage Settings
  • Access Control
  • E-Mail
  • Default Reviewers
  • Permission Groups
  • Repositories
  • Review Groups
  • Users
  • Extensions
  • Site Maintenance
  • The rb-site Tool
  • Search Indexing
  • Advanced Management Commands
  • Web API Guide
  • Overview
  • Authenticating
  • Rich Text Fields and Types
  • 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
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info 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
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Original File Resource
  • Patched File 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 Account List Resource
  • Hosting Service Account Resource
  • Hosting Service Account Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info 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
  • Review Request Resource
  • Change List Resource
  • Change Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff 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 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
  • 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 File Diff List Resource
  • Draft File Diff Resource
  • Draft Diff Resource
  • Draft File Diff List Resource
  • Draft File Diff Resource
  • Draft Original File Resource
  • Draft Patched File 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 Diff List Resource
  • Draft File Attachment List Resource
  • Draft File Attachment Resource
  • Draft Screenshot List Resource
  • Draft Screenshot 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 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 Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply File Attachment 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 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 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 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 Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request 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 List 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
  • 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
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • Glossary
  • REST API 2.0
  • Overview
  • Authenticating
  • Rich Text Fields and Types
  • 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
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Search Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Validation List Resource
  • Validate Diff List Resource
  • Server Info Resource
  • Default Reviewer List Resource
  • Default Reviewer Resource
  • Default Reviewer Resource
  • Diff Context Resource
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff 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 Account List Resource
  • Hosting Service Account Resource
  • Hosting Service Account Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info Resource
  • Repository Resource
  • Diff File Attachment List Resource
  • Diff File Attachment Resource
  • Repository Branches Resource
  • Repository Commits Resource
  • Repository Info 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
  • 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
  • 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 File Diff List Resource
  • Draft Diff Resource
  • Draft File Diff List Resource
  • Draft File Diff 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
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review File Attachment 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 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 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 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 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 Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Search Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List 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 List 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
  • 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
  • 230 - Could not close review request
  • 231 - Could not reopen review request
  • Glossary
  • Extending Review Board
  • Writing Review Board Extensions
  • Overview
  • File Layout
  • Extension Class
  • Extension Configuration
  • Database Models
  • Extension Hooks
  • AuthBackendHook
  • AccountPagesHook
  • AccountPageFormsHook
  • Action Hooks
  • CommentDetailDisplayHook
  • DashboardSidebarItemsHook
  • DashboardColumnsHook
  • DataGridColumnsHook
  • EmailHook
  • ReviewRequestPublishedEmailHook
  • ReviewRequestClosedEmailHook
  • ReviewPublishedEmailHook
  • ReviewReplyPublishedEmailHook
  • FileAttachmentThumbnailHook
  • HostingServiceHook
  • NavigationBarHook
  • ReviewRequestApprovalHook
  • ReviewRequestFieldSetsHook
  • ReviewRequestFieldsHook
  • ReviewUIHook
  • SignalHook
  • TemplateHook
  • URLHook
  • UserPageSidebarItemsHook
  • Static Files
  • Review UI Integration
  • Extending the Web API
  • Testing Extensions
  • Extension Distribution
  • Writing Authentication Backends
  • Writing Legacy Authentication Backends
  • Frequently Asked Questions
  • General Index
  • Release Notes
  • This documentation covers Review Board 2.0. You can select a version above or view the latest documentation.

    Review Request Draft Resource¶

    An editable draft of a review request.

    This resource is used to actually modify a review request. Anything made in this draft can be published in order to become part of the public review request, or it can be discarded.

    Any POST or PUTs on this draft will cause the draft to be created automatically. An initial POST is not required.

    There is only ever a maximum of one draft per review request.

    In order to access this resource, the user must either own the review request, or it must have the reviews.can_edit_reviewrequest permission set.

    Details¶

    Name draft
    URI /api/review-requests/{review_request_id}/draft/
    HTTP Methods
    • DELETE - Deletes a draft of a review request.
    • GET - Returns the current draft of a review request.
    • PUT - Updates a draft of a review request.
    Parent Resource Review Request Resource
    Child Resources
    • Draft Diff List Resource
    • Draft File Attachment List Resource
    • Draft Screenshot List Resource
    Anonymous Access No

    Fields¶

    branchString The branch name.
    bugs_closedString The new list of bugs closed or referenced by this change.
    changedescriptionRich Text A custom description of what changes are being made in this update. It often will be used to describe the changes in the diff.
    changedescription_text_typeOne of plain, markdown, html

    The current or forced text type for the changedescription field.

    Added in 2.0.12

    commit_idString

    The updated ID of the commit this review request is based upon.

    Added in 2.0

    depends_onList of Review Request Resource The list of review requests that this review request depends on.
    descriptionRich Text The new review request description.
    description_text_typeOne of plain, markdown, html

    The current or forced text type for the description field.

    Added in 2.0.12

    extra_dataDictionary Extra data as part of the draft. This can be set by the API or extensions.
    idInteger The numeric ID of the draft.
    last_updatedString The date and time that the draft was last updated (in YYYY-MM-DD HH:MM:SS format).
    publicBoolean Whether or not the draft is public. This will always be false up until the time it is first made public. At that point, the draft is deleted.
    review_requestReview Request Resource The review request that owns this draft.
    summaryString The new review request summary.
    target_groupsString A comma-separated list of review groups that will be on the reviewer list.
    target_peopleString A comma-separated list of users that will be on a reviewer list.
    testing_doneRich Text The new testing done text.
    testing_done_text_typeOne of plain, markdown, html

    The current or forced text type for the testing_done field.

    Added in 2.0.12

    text_typeOne of plain, markdown, html Deprecated

    Formerly responsible for indicating the text type for text fields. Replaced by changedescription_text_type, description_text_type, and testing_done_text_type in 2.0.12.

    Added in 2.0

    Deprecated in 2.0.12

    Links¶

    Name Method Resource
    delete DELETE Review Request Draft Resource
    draft_diffs GET Draft Diff List Resource
    draft_file_attachments GET Draft File Attachment List Resource
    draft_screenshots GET Draft Screenshot List Resource
    self GET Review Request Draft Resource
    update PUT Review Request Draft Resource

    HTTP DELETE¶

    Deletes a draft of a review request.

    This is equivalent to pressing Discard Draft in the review request’s page. It will simply erase all the contents of the draft.

    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

    HTTP GET¶

    Returns the current draft of a review request.

    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

    HTTP PUT¶

    Updates a draft of a review request.

    This will update the draft with the newly provided data.

    Most of the fields correspond to fields in the review request, but there is one special one, public. When public is set to true, the draft will be published, moving the new content to the review request itself, making it public, and sending out a notification (such as an e-mail) if configured on the server. The current draft will then be deleted.

    Extra data can be stored on the review request for later lookup by passing extra_data.key_name=value. The key_name and value can be any valid strings. Passing a blank value will remove the key. The extra_data. prefix is required.

    Request Parameters¶

    branchString The new branch name.
    bugs_closedString A comma-separated list of bug IDs.
    changedescriptionRich Text The change description for this update.
    changedescription_text_typeOne of plain, markdown

    The text type used for the changedescription field.

    Added in 2.0.12

    commit_idString

    The updated ID of the commit this review request is based upon.

    Added in 2.0

    depends_onString The new list of dependencies of this review request.
    descriptionRich Text The new review request description.
    description_text_typeOne of plain, markdown

    The text type used for the description field.

    Added in 2.0.12

    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.
    publicBoolean Whether or not to make the review public. If a review is public, it cannot be made private again.
    summaryString The new review request summary.
    target_groupsString A comma-separated list of review groups that will be on the reviewer list.
    target_peopleString A comma-separated list of users that will be on a reviewer list.
    testing_doneRich Text The new testing done text.
    testing_done_text_typeOne of plain, markdown

    The text type used for the testing_done field.

    Added in 2.0.12

    text_typeOne of plain, markdown Deprecated

    The mode for the changedescription, description, and testing_done fields.

    This is deprecated. Please use changedescription_text_type, description_text_type, and testing_done_text_type instead.

    Added in 2.0

    Deprecated in 2.0.12

    update_from_commit_idBoolean

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

    Added in 2.0

    Errors¶

    100 - Does Not ExistHTTP 404 - Not Found Object does not exist
    101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
    103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
    105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors
    203 - Invalid Change NumberHTTP 404 - Not Found The commit ID specified could not be found.
    225 - Publish ErrorHTTP 500 - Internal Server Error An error occurred during publishing.
    227 - Commit ID Already ExistsHTTP 409 - Conflict Review request with this commit ID already exists in the repository.

    Examples¶

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

    $ curl http://reviews.example.com/api/review-requests/8/draft/ -H "Accept: application/json"
    
    Vary: Accept, Cookie
    ETag: 89d328522e4e080118a804f4f32655e92c224abf
    Content-Type: application/vnd.reviewboard.org.review-request-draft+json
    X-Content-Type-Options: nosniff
    
    {
      "draft": {
        "branch": "master", 
        "bugs_closed": [
          "12", 
          "34"
        ], 
        "changedescription": "", 
        "changedescription_text_type": "plain", 
        "commit_id": null, 
        "depends_on": [], 
        "description": "This is the new description.", 
        "description_text_type": "plain", 
        "extra_data": {}, 
        "id": 1, 
        "last_updated": "2010-08-16T00:47:29Z", 
        "links": {
          "delete": {
            "href": "http://reviews.example.com/api/review-requests/8/draft/", 
            "method": "DELETE"
          }, 
          "draft_diffs": {
            "href": "http://reviews.example.com/api/review-requests/8/draft/diffs/", 
            "method": "GET"
          }, 
          "draft_file_attachments": {
            "href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/", 
            "method": "GET"
          }, 
          "draft_screenshots": {
            "href": "http://reviews.example.com/api/review-requests/8/draft/screenshots/", 
            "method": "GET"
          }, 
          "review_request": {
            "href": "http://reviews.example.com/api/review-requests/8/", 
            "method": "GET", 
            "title": "Interdiff Revision Test"
          }, 
          "self": {
            "href": "http://reviews.example.com/api/review-requests/8/draft/", 
            "method": "GET"
          }, 
          "update": {
            "href": "http://reviews.example.com/api/review-requests/8/draft/", 
            "method": "PUT"
          }
        }, 
        "public": false, 
        "summary": "This is the new summary", 
        "target_groups": [], 
        "target_people": [
          {
            "href": "http://reviews.example.com/api/users/grumpy/", 
            "method": "GET", 
            "title": "grumpy"
          }
        ], 
        "testing_done": "This is the new testing that was done.", 
        "testing_done_text_type": "plain", 
        "text_type": null
      }, 
      "stat": "ok"
    }
    

    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
    • Fields
    • Links
    • HTTP DELETE
      • Errors
    • HTTP GET
      • Errors
    • HTTP PUT
      • Request Parameters
      • Errors
    • Examples
      • application/vnd.reviewboard.org.review-request-draft+json