ごみ箱内のウェブリンク

APIバージョン 2024.0 ごみ箱内のウェブリンクを表します。

string

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

type

string

例 web_link値は常にweb_linkになります。次の値に固定: web_link

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルがBoxのサーバー上に作成された日時。

created_by

ユーザー (Mini)object

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

description

string

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

etag

string

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

item_status

string

例 trashedこの項目が削除されたかどうか。値には、active、trashed (ファイルがごみ箱に移動された場合)、deleted (ファイルが完全に削除された場合) があります。次の値のいずれか1つ: active,trashed,deleted

modified_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルがBoxサーバー上で最後に更新された日時。

modified_by

ユーザー (Mini)object

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

name

string

例 My Bookmarkウェブリンクの名前。

owned_by

ユーザー (Mini)object

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

parent

フォルダ (Mini)object

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

path_collection

object

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

表示子属性

entries

object[]

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

表示子属性

string

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

type

string

例 folder値は常にfolderになります。次の値に固定: folder

etag

string

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

name

string

例 Trashごみ箱フォルダの名前。

sequence_id

string

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

total_count

integer(int64)

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

purged_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルが完全に削除される日時。

sequence_id

string

例 3この項目に適用された最新のUser Eventを表す数値の識別子。これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。

shared_link

string

このブックマークの共有リンク。ブックマークがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これはnullになります。

trashed_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルが最後にごみ箱に移動された日時。

url

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