メインコンテンツへスキップ
GET
/
web_links
/
{web_link_id}
#get_shared_link
ウェブリンクの共有リンクを取得
curl -i -X GET "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "id": "12345",
  "type": "web_link",
  "etag": "1",
  "shared_link": {
    "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
    "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
    "vanity_url": null,
    "vanity_name": null,
    "effective_access": "open",
    "effective_permission": "can_download",
    "is_password_enabled": false,
    "unshared_at": "2020-09-21T10:34:41-07:00",
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_preview": true,
      "can_download": true,
      "can_edit": false
    }
  }
}
このリソースは、バージョン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
required

この項目に返されるshared_linkフィールドを明示的にリクエストします。

Response

追加の共有リンク情報を含むウェブリンクのBase版の表示を返します。

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

ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。 ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。

ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。 ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。

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

​
id
string
required

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

Example:

"11446498"

​
type
enum<string>
required

値は常にweb_linkになります。

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

"web_link"

​
etag
string

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

Example:

"1"

​
url
string

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

Example:

"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をすべて無視します。

Example:

"3"

​
name
string

ウェブリンクの名前。

Example:

"My Bookmark"

​
parent
フォルダ (Mini) · object

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

​
description
string

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

Example:

"Example page"

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

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

​
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<date-time> | null

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

Example:

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

​
purged_at
string<date-time> | null

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

Example:

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

​
created_by
ユーザー (Mini) · object

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

​
modified_by
ユーザー (Mini) · object

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

​
owned_by
ユーザー (Mini) · object

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

​
shared_link
共有リンク · object

この項目の共有リンクオブジェクト。共有リンクがまだ作成されていない場合は、nullになります。

​
item_status
enum<string>

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

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

"active"