ウェブリンク

ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。

ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、標準バリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
11446498

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

string
web_link

次の値に固定: web_link

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

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

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

Example page

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

string
1

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

active

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

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

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

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

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

string
My Bookmark

ウェブリンクの名前

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

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

ルートを起点にした、このリンクまでのフォルダのパス

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

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

3

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

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

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

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": "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": [
    {
      "id": 12345,
      "etag": 1,
      "type": "folder",
      "sequence_id": 3,
      "name": "Contracts"
    }
  ],
  "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_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"
}