Comments

Comments are discussions around content and can be added to a folder or file in Onehub. You can create, delete, and list comments. Comments are identified by a unique, random ID.

Create a Comment

POST https://ws-api.onehub.com/:item/:item_id/comments

Creates a comment on the :item (folder or file) specified via :item_id.

Path Parameters

NameTypeDescription

:item

string

The type of item. Can either be folders or files.

:item_id

integer

The unique identifier of the item that you would like to create the comment on.

Request Body

NameTypeDescription

body

string

The text of the comment.

{
  "comment": {
    "id": 9417,
    "user_id": 481,
    "discussion_id": 468087,
    "body": "This is an example comment.",
    "updated_at": "2016-01-15T16:24:37-08:00",
    "user_name": "Matthew Anderson",
    "owner_type": "file",
    "owner_id": 849607
  }
}

Delete a Comment

DELETE https://ws-api.onehub.com/:item/:item_id/comments/:id

Deletes the comment specified via :id from the :item (folder or file) specified via :item_id.

Path Parameters

NameTypeDescription

:item

string

The type of item. Can either be folders or files.

:item_id

integer

The unique identifier of the item you would like to delete the comment from.

:id

integer

The unique identifier of the comment you would like to delete.

List all Comments

GET https://ws-api.onehub.com/:item/:item_id/comments

Lists all comment for the :item (folder or file) specified via :item_id.

Path Parameters

NameTypeDescription

:item

string

The type of item. Can either be folders or files.

:item_id

integer

The unique identifier of the item that you would like to list comments from.

{
  "total_entries": 1,
  "current_page": 1,
  "total_pages": 1,
  "per_page": 15,
  "items": [
    {
      "comment": {
        "id": 9417,
        "user_id": 481,
        "discussion_id": 468087,
        "body": "This is an example comment.",
        "updated_at": "2016-01-15T16:24:37-08:00",
        "user_name": "Matthew Anderson",
        "owner_type": "file",
        "owner_id": 849607
      }
    }
  ]
}

Last updated