Watched Review Request Resource¶

Lists and manipulates entries for review requests watched by the user.

These are requests that the user has starred in their Dashboard. This resource can be used for listing existing review requests and adding new review requests to watch.

Each item in the resource is an association between the user and the review request. The entries in the list are not the review requests themselves, but rather an entry that represents this association by listing the association’s ID (which can be used for removing the association) and linking to the review request.

Details¶

Name	`watched_review_request`
URI	`/api/users/{username}/watched/review-requests/{watched_obj_id}/`
Token Policy ID	`watched_review_request`
HTTP Methods	DELETE - Deletes a watched review request entry. GET - Redirects to the review request being watched.
Parent Resource	Watched Review Request List Resource
Child Resources	None

Links¶

Name	Method	Resource
create	POST	Watched Review Request Resource
self	GET	Watched Review Request Resource

HTTP DELETE¶

Deletes a watched review request entry.

This is the same effect as unstarring a review request. It does not actually delete the review request, just the entry in the list.

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
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 GET¶

Redirects to the review request being watched.

Rather than returning a body with the entry, performing an HTTP GET on this resource will redirect the client to the actual review request being watched.

Clients must properly handle HTTP 302 Found and expect this redirect to happen.

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
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.

Examples¶

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

$ curl https://reviews.example.com/api/users/admin/watched/review-requests/8/ -H "Accept: application/json"

HTTP 302 Found
Content-Length: 0
Location: https://reviews.example.com/api/review-requests/8/
Vary: Accept, Cookie