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 |
| OAuth access token | Authorized access token per user for an hour by default. |
| id | Identifier of the comment |
| start | Start page number |
| size | Number of comments to be fetched |
| user | name of the user |
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 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 }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Description | This retrieves all the comments posted on the specific resource. |
| Response Type | JSON |
Get a Specific Comment on a Resource
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /comment?path={ resource path }&id={ comment ID }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Description | This retrieves the specific comment associated with the given comment ID. |
| Response Type | JSON |
Add a Comment to a Resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | /comment?path={ resource path }&user={ user name } |
| HTTP Request Header | Authorization: Bearer {OAuth access token} Content-Type: text/plain |
| Payload | Comment appears in text format |
| Description | Add the payload comment to the requested resource |
| Response Type | JSON |
Update a Comment on a Resource
| Attributes | Values |
|---|---|
HTTP Method | PUT |
| Request URI | /comment?path={ resource path }&id={ comment ID }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } Content-Type: text/plain |
| Payload | New comment to be updated as TEXT. |
| Description | It replaces the new comment for the given commentID |
| Response Type | JSON |
Delete a Comment on a Resource
| Attributes | Values |
|---|---|
HTTP Method | DELETE |
| Request URI | /comment?path={ resource path }&id={ comment ID }&user={ user name } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Response | HTTP 204 No Content |
| Response Type | JSON |