URL: /api/comment
Request Headers
| Authorization | A Bearer authorization token, from auth token api. Example: Authorization: Bearer 123-BodrEJHrC43KejPcM0nzTl05gUMi3i8ruzGN |
Create Comment
Method: POST
Request Body
The request body is a JSON formatted representation of the file.
| file_id | Required. The id of the file to add the comment to. |
| text |
Required. The comment, use \n for line breaks. |
| parent | Optional. Id of the parent comment. Use this to create replies. |
| tc |
Optional. A list of time code objects associated with the comment. The first will be used in the Share UI. Each time code object contains in and out. Which represents in/out point in in milliseconds relative to the file (not using any source offset). |
Response
The created comment, see Get Comment.
Get Comment
URL: /api/comment/{id}
Method: GET
Response
| id | Integer. The comment id. |
| file_id | Integer. The file id. |
| owner | User profile for the owner of the share. Object contains: id, username, realname, accountname, email, address, mobile, expires, and status.
Status may be: Active, Inactive, Blocked, or ValidationRequired. |
| removed | Boolean. Deleted comments are marked removed. |
| created | String. Creation date. |
| parent | Integer or null. If the comment is a reply, this is the parent comment. |
| text | The text. |
| tc | A list of time code objects associated with the comment. Each object has a in and out parameter. Times are are milliseconds into file (not including any source offset). |
Update Comment
URL: /api/comment/{id}
Method: PUT
Same request body as in the POST call.
Delete Comment
URL: /api/comment/{id}
Method: DELETE
Response code will be 204 if success.