コメント (Full)

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

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

id string

例11446498

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

type string

例comment

comment

次の値に固定: comment

created_at string (date-time)

例2012-12-12T10:53:43-08:00

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

created_byユーザー (Mini) object

コメント作成者をMini版のユーザーオブジェクトで表示

is_reply_comment boolean

例true

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

item object

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

item.id string

例11446498

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

item.type string

例file

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

message string

例@Aaron Levie these tigers are cool!

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

modified_at string (date-time)

例2012-12-12T10:53:43-08:00

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

tagged_message string

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

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

レスポンスの例

{
  "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!"
}