メインコンテンツへスキップ
GET
/
web_links
/
{web_link_id}
/
trash
cURL
curl -i -X GET "https://api.box.com/2.0/web_links/12345/trash" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "type": "web_link",
  "id": "11446498",
  "sequence_id": "3",
  "etag": "1",
  "name": "My Bookmark",
  "url": "https://www.example.com/example/1234",
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "description": "Example page",
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "123456789",
        "sequence_id": null,
        "etag": null,
        "name": "Trash"
      }
    ]
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "purged_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "shared_link": null,
  "item_status": "trashed"
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

​
web_link_id
string
必須

ウェブリンクのID。

クエリパラメータ

​
fields
string[]

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

レスポンス

ごみ箱に移動された日時の情報を含め、ごみ箱内にあるウェブリンクを返します。

ごみ箱内のウェブリンクを表します。

​
type
enum<string>

値は常にweb_linkになります。

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

"web_link"

​
id
string

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

例:

"11446498"

​
sequence_id
string | null

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

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

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

例:

"3"

​
etag
string

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

例:

"1"

​
name
string

ウェブリンクの名前。

例:

"My Bookmark"

​
url
string

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

例:

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

​
parent
フォルダ (Mini) · object

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

​
description
string

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

例:

"Example page"

​
path_collection
パスのコレクション (ごみ箱) · object

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

​
created_at
string<date-time>

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

例:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>

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

例:

"2012-12-12T10:53:43-08:00"

​
trashed_at
string<date-time> | null

このファイルが最後にごみ箱に移動された日時。

例:

"2012-12-12T10:53:43-08:00"

​
purged_at
string<date-time> | null

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

例:

"2012-12-12T10:53:43-08:00"

​
created_by
ユーザー (Mini) · object

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

​
modified_by
ユーザー (Mini) · object

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

​
owned_by
ユーザー (Mini) · object

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

​
shared_link
string | null

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

例:

null

​
item_status
enum<string>

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

利用可能なオプション:
active,
trashed,
deleted
例:

"trashed"