メインコンテンツへスキップ
POST
/
web_links
/
{web_link_id}
cURL
curl -i -X POST "https://api.box.com/2.0/web_links/12345" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "sequence_id": "3",
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "type": "web_link",
  "id": "11446498",
  "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",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "trashed_at": null,
  "purged_at": null,
  "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"
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
web_link_id
string
required

ウェブリンクのID。

Query Parameters

​
fields
string[]

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

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

Body

application/json
​
name
string

ウェブリンクの新しい名前 (省略可)。

Example:

"Restored.docx"

​
parent
object

元のフォルダがすでに存在しない場合にウェブリンクの復元先となるフォルダのID (省略可) を指定します。

このIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にウェブリンクの復元先となるフォールバックの場所を指定します。

Response

ウェブリンクオブジェクトが復元された場合は、そのオブジェクトを返します。

ごみ箱から復元されたウェブリンクを表します。

​
sequence_id
string | null
required

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

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

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

Example:

"3"

​
path_collection
パスのコレクション · object
required

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

​
type
enum<string>

値は常にweb_linkになります。

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

"web_link"

​
id
string

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

Example:

"11446498"

​
etag
string

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

Example:

"1"

​
name
string

ウェブリンクの名前。

Example:

"My Bookmark"

​
url
string

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

Example:

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

​
parent
フォルダ (Mini) · object

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

​
description
string

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

Example:

"Example page"

​
created_at
string<date-time>

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

Example:

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

​
modified_at
string<date-time>

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

Example:

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

​
trashed_at
string | null

このブックマークがごみ箱に移動された日時。復元後はnullになります。

Example:

null

​
purged_at
string | null

このブックマークが完全に削除される予定日時。復元後はnullになります。

Example:

null

​
created_by
ユーザー (Mini) · object

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

​
modified_by
ユーザー (Mini) · object

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

​
owned_by
ユーザー (Mini) · object

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

​
shared_link
string | null

このブックマークの共有リンク。ブックマークがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これはnullになります。

Example:

null

​
item_status
enum<string>

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

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

"trashed"