コメント (詳細)

コメントとは、ファイルに関して作成されるメッセージです。コメントは単独で作成することも、他のコメントへの返答として作成することもできます

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

string
11446498

このコメントの一意の識別子。

string
comment

Value is always comment

string / date-time
2012-12-12T10:53:43-08:00

このコメントが作成された日時

コメントの作成者を表す簡易版のユーザーオブジェクト

true

このコメントが他のコメントへの返信かどうか

object

このコメントが追加されたファイル

string
11446498

このオブジェクトの一意の識別子

string
file

このオブジェクトのタイプ

string
@Aaron Levie these tigers are cool!

ユーザーが入力したコメントのテキスト

string / date-time
2012-12-12T10:53:43-08:00

このコメントが最後に変更された日時

@[1234567:Aaron Levie] these tigers are cool!

@メンションを含むコメントテキストを表す文字列。@メンションの形式は@[id:username][id:username]で、idはユーザーのBox ID、usernameはユーザーの表示名になります。

Response Example

{
  "id": 11446498,
  "type": "comment",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "is_reply_comment": true,
  "item": {
    "id": 11446498,
    "type": "file"
  },
  "message": "@Aaron Levie these tigers are cool!",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "tagged_message": "@[1234567:Aaron Levie] these tigers are cool!"
}