メインコンテンツへスキップ

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

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

id
string
必須

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

:

"11446498"

type
enum<string>
必須

値は常にweb_linkになります。

利用可能なオプション:
web_link
:

"web_link"

etag
string

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

:

"1"

url
string

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

:

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

sequence_id
string | null

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

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

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

:

"3"

name
string

ウェブリンクの名前。

:

"My Bookmark"