Root File Attachment Comment List Resource¶

Added in 5.0

Provide information on file attachment comments.

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

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

Details¶

Name	`file_attachment_comments`
URI	`/api/file-attachment-comments/`
Token Policy ID	`file_attachment_comment`
HTTP Methods	GET - Return the list of file attachment comments.
Parent Resource	Root List Resource
Child Resources	None

Links¶

Name	Method	Resource
self	GET	Root File Attachment Comment List Resource

HTTP GET¶

Return the list of file attachment comments.

Request Parameters¶

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

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

HTTP 200 OK
Content-Length: 2330
Content-Type: application/vnd.reviewboard.org.file-attachment-comments+json
ETag: 43d293035259cde345338ecbe6b204109b7c5c07
Item-Content-Type: application/vnd.reviewboard.org.file-attachment-comment+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "file_attachment_comments": [
    {
      "diff_against_file_attachment": null,
      "extra_data": {},
      "id": 1,
      "issue_opened": false,
      "issue_status": "",
      "link_text": "Example Attachment",
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/",
          "method": "DELETE"
        },
        "file_attachment": {
          "href": "https://reviews.example.com/api/review-requests/8/file-attachments/1/",
          "method": "GET",
          "title": "Example Attachment"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/admin/",
          "method": "GET",
          "title": "admin"
        }
      },
      "public": true,
      "review_url": "/r/8/#fcomment1",
      "text": "A fantastic comment on a fantastic file!",
      "text_type": "plain",
      "thumbnail_html": null,
      "timestamp": "2011-08-26T02:49:32Z"
    },
    {
      "diff_against_file_attachment": null,
      "extra_data": {},
      "id": 2,
      "issue_opened": false,
      "issue_status": "",
      "link_text": "Example Attachment",
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/",
          "method": "DELETE"
        },
        "file_attachment": {
          "href": "https://reviews.example.com/api/review-requests/8/file-attachments/1/",
          "method": "GET",
          "title": "Example Attachment"
        },
        "reply_to": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/",
          "method": "GET",
          "title": "A fantastic comment on a fantastic file!"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/admin/",
          "method": "GET",
          "title": "admin"
        }
      },
      "public": true,
      "review_url": "/r/8/#fcomment2",
      "text": "A reply to a fantastic comment.",
      "text_type": "plain",
      "thumbnail_html": null,
      "timestamp": "2011-08-26T02:52:57Z"
    }
  ],
  "links": {
    "self": {
      "href": "https://reviews.example.com/api/file-attachment-comments/",
      "method": "GET"
    }
  },
  "stat": "ok",
  "total_results": 2
}