Watched List Resource¶
Resource that links to watched items resources for a user.
This is more of a linking resource rather than a data resource, much like the root resource is. The sole purpose of this resource is for easy navigation to the more specific Watched Items resources.
Details¶
Name | watched |
URI | /api/users/{username}/watched/ |
Token Policy ID | watched |
HTTP Methods |
|
Parent Resource | |
Child Resources |
Links¶
Name |
Method |
Resource |
---|---|---|
self | GET |
|
watched_review_groups | GET |
|
watched_review_requests | GET |
HTTP GET¶
Retrieves the list of Watched Items resources.
Unlike most resources, the result of this resource is just a list of links, rather than any kind of data. It exists in order to index the more specific Watched Review Groups and Watched Review Requests resources.
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+json¶
$ curl https://reviews.example.com/api/users/admin/watched/ -H "Accept: application/json"
HTTP 200 OK
Content-Length: 364
Content-Type: application/vnd.reviewboard.org.watched+json
ETag: 38b99c68967d53101e81b59710d416186113c5ca
Vary: Accept, Cookie
X-Content-Type-Options: nosniff
{
"links": {
"self": {
"href": "https://reviews.example.com/api/users/admin/watched/",
"method": "GET"
},
"watched_review_groups": {
"href": "https://reviews.example.com/api/users/admin/watched/review-groups/",
"method": "GET"
},
"watched_review_requests": {
"href": "https://reviews.example.com/api/users/admin/watched/review-requests/",
"method": "GET"
}
},
"stat": "ok"
}