ウェブリンク (Mini)

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

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

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

通常、Miniバリアントに含まれるフィールドは、このリソースが別のリソースのレスポンス内にネストされている場合に返されます。

id string

例11446498

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

type string

例web_link

web_link

次の値に固定: web_link

etag string

例1

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

name string

例My Bookmark

ウェブリンクの名前

sequence_id string

例3

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

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

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

url string

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

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

レスポンスの例

{
  "id": "11446498",
  "type": "web_link",
  "etag": "1",
  "name": "My Bookmark",
  "sequence_id": "3",
  "url": "https://www.example.com/example/1234"
}