ウェブリンク
ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。
11446498このウェブリンクの一意の識別子。
web_link値は常にweb_linkになります。
次の値に固定: web_link
2012-12-12T10:53:43-08:00このファイルがBoxのサーバー上に作成された日時。
このウェブリンクを作成したユーザー。
Example pageウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。
1このウェブリンクのエンティティタグ。If-Matchヘッダーで使用します。
activeこの項目が削除されたかどうか。値には、active、trashed (ファイルがごみ箱に移動された場合)、deleted (ファイルが完全に削除された場合) があります。
次の値のいずれか1つ: active,trashed,deleted
2012-12-12T10:53:43-08:00このファイルがBoxサーバー上で最後に更新された日時。
このウェブリンクを最後に変更したユーザー。
My Bookmarkウェブリンクの名前。
このウェブリンクを所有するユーザー。
ウェブリンクが属する親オブジェクト。
ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。
この項目の親フォルダ。
1このリスト内のフォルダの数。
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をすべて無視します。
2012-12-12T10:53:43-08:00このファイルがごみ箱に移動された日時。
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": "active",
"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": "1",
"id": "12345",
"type": "folder",
"name": "Contracts",
"sequence_id": "3"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"sequence_id": "3",
"shared_link": {
"access": "open",
"download_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_name": "my_url",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"trashed_at": "2012-12-12T10:53:43-08:00",
"url": "https://www.example.com/example/1234"
}