Box Developerドキュメント

ごみ箱内のウェブリンク

ごみ箱内のウェブリンクを表します。

string
11446498

このウェブリンクの一意の識別子

string
web_link

web_link

次の値に固定: web_link

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

このファイルがBoxのサーバー上に作成された日時。

このウェブリンクを作成したユーザー

Example page

ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。

string
1

このウェブリンクのエンティティタグ。If-Matchヘッダーで使用します。

trashed

この項目が削除されたかどうか。値には、activetrashed (ファイルがごみ箱に移動された場合)、deleted (ファイルが完全に削除された場合) があります。

次の値のいずれか1つ: active,trashed,deleted

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

このファイルがBoxサーバー上で最後に更新された日時。

このウェブリンクを最後に変更したユーザー

string
My Bookmark

ウェブリンクの名前

このウェブリンクを所有するユーザー

ウェブリンクが属する親オブジェクト

ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。

この項目のパスのコレクションのフォルダの配列

123456789

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

folder

folder

次の値に固定: folder

ごみ箱フォルダの場合、このフィールドはnullです

Trash

ごみ箱フォルダの名前。

ごみ箱フォルダの場合、このフィールドはnullです

1

このリスト内のフォルダの数。

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

このファイルが完全に削除される日時。

3

この項目に適用された最新のUser Eventを表す数値の識別子。

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

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

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

このファイルが最後にごみ箱に移動された日時。

string
https://www.example.com/example/1234

このウェブリンクが指すURL

レスポンスの例

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "trashed",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "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"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "null",
        "id": "123456789",
        "name": "Trash",
        "sequence_id": "null",
        "type": "folder"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": "null",
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "url": "https://www.example.com/example/1234"
}