イベントソース

イベントストリーム内のイベントを開始させるソースファイルまたはフォルダ。

string
560284318361

項目を表す一意の識別子。

string
report.pdf

項目の名前。

string
file

イベントを表す項目の種類。fileまたはfolderになります。

次の値のいずれか1つ: file,folder

object

この項目を所有するユーザー

11446498

このユーザーの一意の識別子

user

次の値に固定: user

string / email
ceo@example.com

このユーザーのプライマリメールアドレス

Aaron Levie50

このユーザーの表示名

object

このフォルダが配置されているフォルダ(省略可)

ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、 この値はnullになることがあります。

string
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folders/123の場合、folder_id123です。

folder

次の値に固定: folder

1

このフォルダのHTTP etag。これは変更が発生した場合(またはしなかった場合)にフォルダに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

Contracts

フォルダの名前。

3

この項目に適用された最新のユーザーイベントを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるユーザーイベントを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するユーザーイベントの発生を監視する場合などがこれに該当します。ユーザーイベントのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなユーザーイベントをすべて無視します。

レスポンスの例

{
  "item_id": 560284318361,
  "item_name": "report.pdf",
  "item_type": "file",
  "owned_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": 12345,
    "type": "folder",
    "etag": 1,
    "name": "Contracts",
    "sequence_id": 3
  }
}