Root General Comment List Resource¶

Added in 5.0

Provide information on general comments.

This is a top level endpoint that allows you to list and query all general comments in the system, across different review requests.

Version Changed:: 5.0.4: This was formally named general_comments on the root resource, but had to be renamed to all_general_comments in order to work around a conflict with URI templates.
Version Added:: 5.0

Details¶

Name	`general_comments`
URI	`/api/general-comments/`
Required Features	reviews.general_comments
Token Policy ID	`general_comment`
HTTP Methods	GET - Return the list of general comments.
Parent Resource	Root List Resource
Child Resources	None

Links¶

Name	Method	Resource
self	GET	Root General Comment List Resource

HTTP GET¶

Return the list of general comments.

Request Parameters¶

counts-onlyBoolean	If specified, a single `count` field is returned with the number of results, instead of the results themselves.
is-replyBoolean	Determine whether to return general comments that are replies or not.
last-updated-from ISO 8601 Date/Time	The earliest date/time the general comments could be last updated. This is compared against the general comment’s `timestamp` field. This must be a valid date/time format.
last-updated-to ISO 8601 Date/Time	The date/time that all general comments must be last updated before. This is compared against the general comment’s `timestamp` 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.
review-idString	The ID of the review that the general comments must belong to.
review-request-idString	The ID of the review request that the general comments must belong to.
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.
userString	The username of the user that created the general comments.

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.

Examples¶

application/vnd.reviewboard.org.general-comments+json¶

$ curl https://reviews.example.com/api/general-comments/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 1673
Content-Type: application/vnd.reviewboard.org.general-comments+json
ETag: 8829105241bbddceb61165cbf5b709693f31de2e
Item-Content-Type: application/vnd.reviewboard.org.general-comment+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "general_comments": [
    {
      "extra_data": {},
      "id": 1,
      "issue_opened": false,
      "issue_status": "",
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/general-comments/1/",
          "method": "DELETE"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/general-comments/1/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/general-comments/1/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/admin/",
          "method": "GET",
          "title": "admin"
        }
      },
      "public": true,
      "text": "This is a general comment",
      "text_type": "plain",
      "timestamp": "2017-10-03T09:02:43Z"
    },
    {
      "extra_data": {},
      "id": 2,
      "issue_opened": false,
      "issue_status": "",
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/",
          "method": "DELETE"
        },
        "reply_to": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/general-comments/1/",
          "method": "GET",
          "title": "This is a general comment"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/general-comments/2/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/admin/",
          "method": "GET",
          "title": "admin"
        }
      },
      "public": true,
      "text": "This is a reply to a general comment",
      "text_type": "plain",
      "timestamp": "2017-10-03T09:02:43Z"
    }
  ],
  "links": {
    "self": {
      "href": "https://reviews.example.com/api/general-comments/",
      "method": "GET"
    }
  },
  "stat": "ok",
  "total_results": 2
}