This documentation covers the in-development release of Review Board. You can see the stable Review Board documentation or all previous versions.
This documentation covers the in-development release of Review Board. You can see the stable Review Board documentation or all previous versions.
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.
5.0.4: This was formally named
file_attachment_comments
on the root resource, but had to be renamed toall_file_attachment_comments
in order to work around a conflict with URI templates.5.0
Details¶
file_attachment_comments
/api/file-attachment-comments/
file_attachment_comment
GET - Return the list of file attachment comments.
Root List Resource
None
Links¶
Name
Method
Resource
GET
Root File Attachment Comment List Resource
HTTP GET¶
Return the list of file attachment comments.
Request Parameters¶
If specified, a single
count
field is returned with the number of results, instead of the results themselves.The ID of the file attachment that the comments must belong to.
The filename of the file attachment name that the comments must belong to.
Determine whether to return file attachment comments that are replies or not.
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.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.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.
The ID of the review that the file attachment comments must belong to.
The ID of the review request that the file attachment comments must belong to.
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.
The username of the user that created the file attachment comments.
Errors¶
Examples¶
application/vnd.reviewboard.org.file-attachment-comments+json¶