Draft File Attachment Resource¶
Provides information on new file attachments being added to a draft of a review request.
These are files that will be shown once the pending review request draft is published.
Details¶
Name | draft_file_attachment |
URI | /api/review-requests/{review_request_id}/draft/file-attachments/{file_attachment_id}/ |
HTTP Methods | |
Parent Resource | Draft File Attachment List Resource |
Child Resources | None |
Anonymous Access | No |
Fields¶
absolute_urlString | The absolute URL of the file, for downloading purposes. Added in 2.0 |
captionString | The file’s descriptive caption. |
filenameString | The name of the file. |
icon_urlString | The URL to a 24x24 icon representing this file. |
idInteger | The numeric ID of the file. |
mimetypeString | The mimetype for the file. |
review_urlString | The URL to a review UI for this file. |
thumbnailString | A thumbnail representing this file. |
urlString | Deprecated The URL of the file, for downloading purposes. If this is not an absolute URL, then it’s relative to the Review Board server’s URL. This is deprecated and will be removed in a future version. Deprecated in 2.0 |
Links¶
Name | Method | Resource |
---|---|---|
delete | DELETE | Draft File Attachment Resource |
self | GET | Draft File Attachment Resource |
update | PUT | Draft File Attachment Resource |
HTTP DELETE¶
Deletes the file attachment from the draft.
This will remove the file attachment from the draft review request. This cannot be undone.
This can be used to remove old files that were previously shown, as well as newly added files that were part of the draft.
Instead of a payload response on success, this will return HTTP 204 No Content.
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 |
HTTP GET¶
Returns the serialized object for the resource.
This will require login if anonymous access isn’t enabled on the site.
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 |
HTTP PUT¶
Updates the file’s data.
This allows updating the file in a draft. The caption, currently, is the only thing that can be updated.
Request Parameters¶
captionString | The new caption for the file. |
thumbnailString | The thumbnail data for the file. |
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 |
Examples¶
application/vnd.reviewboard.org.draft-file-attachment+json¶
$ curl http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/ -H "Accept: application/json"
Vary: Accept, Cookie
ETag: cc052a90d61d111af1456e16bade8702eafa3c38
Content-Type: application/vnd.reviewboard.org.draft-file-attachment+json
X-Content-Type-Options: nosniff
{
"draft_file_attachment": {
"absolute_url": "http://example.com/media/uploaded/images/2010/08/13/screenshot1.png",
"caption": "Example Attachment",
"filename": "screenshot1.png",
"icon_url": "/static/rb/images/mimetypes/image-x-generic.png",
"id": 1,
"links": {
"delete": {
"href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/",
"method": "DELETE"
},
"self": {
"href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/",
"method": "GET"
},
"update": {
"href": "http://reviews.example.com/api/review-requests/8/draft/file-attachments/1/",
"method": "PUT"
}
},
"mimetype": "image/png",
"review_url": "/r/8/file/1/",
"thumbnail": "<img src=\"/media/uploaded/images/2010/08/13/screenshot1_400x100.png\" data-at2x=\"/media/uploaded/images/2010/08/13/screenshot1_800x200.png\" class=\"file-thumbnail\" alt=\"Example Attachment\" />",
"url": "http://example.com/media/uploaded/images/2010/08/13/screenshot1.png"
},
"stat": "ok"
}