Comments リソース - Box Dev Docs

コメントは、ユーザーがファイルに対して生成するメッセージです。コメントを使用すると、複数のユーザーがファイル上でコラボレーションし、コンテンツに対するフィードバックについて話し合うことができます。

Comment

コメントのStandard版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	いいえ	このコメントの一意の識別子。
`type`	`enum<string>`	いいえ	値は常に`comment`になります。使用可能なオプション: `comment`.
`is_reply_comment`	`boolean`	いいえ	このコメントが他のコメントへの返信かどうか。
`message`	`string`	いいえ	ユーザーが入力したコメントのテキスト。
`created_by`	ユーザー (Mini)	いいえ	コメント作成者をMini版のユーザーオブジェクトで表示。
`created_at`	`string`	いいえ	このコメントが作成された日時。
`modified_at`	`string`	いいえ	このコメントが最後に変更された日時。
`item`	`object`	いいえ	オブジェクトの最も基本的な参照。

例

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

Comments

コメントのリスト。

属性と例

プロパティ	型	必須	説明
`total_count`	`integer`	いいえ	コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`offset`	`integer`	いいえ	このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`order`	array of `object`	いいえ	項目が返される順序。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`entries`	array of コメント (Full)	いいえ	コメントのリスト。

例

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

コメント (Base)

コメントのBase版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	いいえ	このコメントの一意の識別子。
`type`	`enum<string>`	いいえ	値は常に`comment`になります。使用可能なオプション: `comment`.

例

{
  "id": "11446498",
  "type": "comment"
}

コメント (Full)

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

属性と例

プロパティ	型	必須	説明
`id`	`string`	いいえ	このコメントの一意の識別子。
`type`	`enum<string>`	いいえ	値は常に`comment`になります。使用可能なオプション: `comment`.
`is_reply_comment`	`boolean`	いいえ	このコメントが他のコメントへの返信かどうか。
`message`	`string`	いいえ	ユーザーが入力したコメントのテキスト。
`created_by`	ユーザー (Mini)	いいえ	コメント作成者をMini版のユーザーオブジェクトで表示。
`created_at`	`string`	いいえ	このコメントが作成された日時。
`modified_at`	`string`	いいえ	このコメントが最後に変更された日時。
`item`	`object`	いいえ	オブジェクトの最も基本的な参照。
`tagged_message`	`string`	いいえ	@メンションを含むコメントテキストを表す文字列。@メンションの形式は@[id:username] で、`id`はユーザーのBox ID、`username`はユーザーの表示名になります。

例

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

​Comment

​Comments

​コメント (Base)

​コメント (Full)

Comment

Comments

コメント (Base)

コメント (Full)