Jump to >

New in version 1.6.

Review Reply File Attachment Comment Resource

Name file_attachment_comment
URI /api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/file-attachment-comments/{comment_id}/
Description

Provides information on replies to file comments made on a review reply.

If the reply is a draft, then comments can be added, deleted, or changed on this list. However, if the reply is already published, then no changed can be made.

HTTP Methods
  • DELETE - Deletes a file comment from a draft reply.
  • GET - Returns information on a reply to a file comment.
  • PUT - Updates a reply to a file comment.
Parent Resource Review Reply File Attachment Comment List Resource
Child Resources None
Anonymous Access Yes, if anonymous site access is enabled

Fields

Field Type Description
file_attachment File Attachment Resource The file the comment was made on.
id Integer The numeric ID of the comment.
issue_opened Boolean Whether or not a comment opens an issue.
issue_status One of dropped, open, resolved The status of an issue.
public Boolean Whether or not the comment is part of a public review.
reply_to Review File Attachment Comment Resource The comment being replied to.
text String The comment text.
timestamp String The date and time that the comment was made (in YYYY-MM-DD HH:MM:SS format).
user User Resource The user who made the comment.

HTTP DELETE

Deletes a file comment from a draft reply.

This will remove the comment from the reply. This cannot be undone.

Only comments on draft replies can be deleted. Attempting to delete a published comment will return a Permission Denied error.

Instead of a payload response, this will return HTTP 204 No Content.

HTTP GET

Returns information on a reply to a file comment.

Much of the information will be identical to that of the comment being replied to.

HTTP PUT

Updates a reply to a file comment.

This can only update the text in the comment. The comment being replied to cannot change.

Request Parameters

Field Type Description
text (required) String The new comment text.

Examples

application/vnd.reviewboard.org.review-reply-file-attachment-comment+json

{
  "file_attachment_comment": {
    "id": 2, 
    "issue_opened": false, 
    "issue_status": "", 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/", 
        "method": "DELETE"
      }, 
      "file_attachment": {
        "href": "http://reviews.example.com/api/review-requests/8/file-attachments/1/", 
        "method": "GET", 
        "title": "Example Attachment"
      }, 
      "reply_to": {
        "href": "http://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": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/", 
        "method": "GET"
      }, 
      "update": {
        "href": "http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/", 
        "method": "PUT"
      }, 
      "user": {
        "href": "http://reviews.example.com/api/users/admin/", 
        "method": "GET", 
        "title": "admin"
      }
    }, 
    "public": true, 
    "text": "A reply to a fantastic comment.", 
    "timestamp": "2011-08-26 02:52:57"
  }, 
  "stat": "ok"
}

application/vnd.reviewboard.org.review-reply-file-attachment-comment+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <file_attachment_comment>
  <issue_opened>0</issue_opened>
  <links>
   <self>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/</href>
    <method>GET</method>
   </self>
   <update>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/</href>
    <method>PUT</method>
   </update>
   <user>
    <href>http://reviews.example.com/api/users/admin/</href>
    <method>GET</method>
    <title>admin</title>
   </user>
   <reply_to>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/1/</href>
    <method>GET</method>
    <title>A fantastic comment on a fantastic file!</title>
   </reply_to>
   <file_attachment>
    <href>http://reviews.example.com/api/review-requests/8/file-attachments/1/</href>
    <method>GET</method>
    <title>Example Attachment</title>
   </file_attachment>
   <delete>
    <href>http://reviews.example.com/api/review-requests/8/reviews/8/replies/10/file-attachment-comments/2/</href>
    <method>DELETE</method>
   </delete>
  </links>
  <timestamp>2011-08-26 02:52:57</timestamp>
  <id>2</id>
  <text>A reply to a fantastic comment.</text>
  <public>1</public>
  <issue_status></issue_status>
 </file_attachment_comment>
</rsp>