This section shows the REST URIs for the following REST operations regarding the comments of a resource.
The following terms explain the meaning of the query parameters passed with the following REST URIs:
| Parameter | Explanation |
|---|---|
| path | Path of the resource |
| id | Identifier of the comment |
| start | Start page number |
| size | Number of comments to be fetched |
The {start page} and {number of records} can take any value greater than or equal to 0. The {start page} and {number of records} begins with 1. If both of them are 0, then all the comments are retrieved. Please note that "start" and "size" are OPTIONAL parameters. If the user omits it will take the default value as 0.
Get All the Comments on a Resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /comments?path={ resource path }&start={ start page }&size={ number of records } |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } |
| Description | This retrieves all the comments posted on the specific resource. |
| Response | HTTP 200 OK |
| Response Type | application/json |
Get a Specific Comment on a Resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /comment?path={ resource path }&id={ comment id } |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } |
| Description | This retrieves the specific comment associated with the given comment id. |
| Response | HTTP 200 OK |
| Response Type | application/json |
Add a Comment to a Resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | /comment?path={ resource path } |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } Content-Type: text/plain |
| Payload | Comment appears in text format |
| Description | Add the payload comment to the requested resource |
| Response | HTTP 204 No Content |
| Response Type | application/json |
Update a Comment on a Resource
| Attributes | Values |
|---|---|
HTTP Method | PUT |
| Request URI | /comment?path={ resource path }&id={ comment id} |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } Content-Type: text/plain |
| Payload | New comment to be updated as TEXT. |
| Description | It replaces the new comment for the given comment id |
| Response | HTTP 204 No Content |
| Response Type | application/json |
Delete a Comment on a Resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | /comment?path={ resource path }&id={ comment id} |
| HTTP Request Header | Authorization: Basic { base64encoded(username:password) } |
| Response | HTTP 204 No Content |
| Response Type | application/json |