...
| Attributes | Values |
|---|---|
HTTP Method | GET |
| Request URI | /comments?path={ resource path }&start={ start page }&size={ number of records } |
| HTTP Request Header | Authorization: Bearer { OAuth access token } |
| Description | This retrieves all the comments posted on the specific resource. |
| Response | HTTP 200 OK |
| Response TypeJSON | 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: Bearer { OAuth access token } |
| Description | This retrieves the specific comment associated with the given comment id. |
| Response | HTTP 200 OK |
| Response TypeJSON | application/json |
Add a Comment to a Resource
| Attributes | Values |
|---|---|
HTTP Method | POST |
| Request URI | /comment?path={ resource path } |
| 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 | HTTP 200 OK204 No Content |
| Response TypeJSON | 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: 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 comment id |
| Response | HTTP 200 OK204 No Content |
| Response TypeJSON | 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: Bearer { OAuth access token } |
| Response | HTTP 200 OK204 No Content |
| Response TypeJSON | application/json |
.