共有リンクのウェブリンクを検索

curl --request GET \
  --url 'https://api.box.com/2.0/shared_items#web_links' \
  --header 'Authorization: Bearer <token>' \
  --header 'boxapi: <boxapi>'

{
  "id": "11446498",
  "type": "web_link",
  "etag": "1",
  "url": "https://www.example.com/example/1234",
  "sequence_id": "3",
  "name": "My Bookmark",
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "description": "Example page",
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "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": {
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "download_count": 3,
    "preview_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "vanity_url": "https://acme.app.box.com/v/my_url/",
    "vanity_name": "my_url",
    "access": "open",
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "permissions": {
      "can_download": true,
      "can_preview": true,
      "can_edit": false
    }
  },
  "item_status": "active"
}

エンドポイント

共有リンクのウェブリンクを検索

共有リンクで表されるウェブリンクを返します。

共有ウェブリンクは、共有リンクで表すことが可能で、現在の企業内に存在する項目である場合も、別の企業内に存在する項目である場合もあります。

アプリケーションからこのエンドポイントを呼び出すと、共有ウェブリンクについての情報を取得できます (共有リンクが存在する場合のみ)。

GET

shared_items#web_links

共有リンクのウェブリンクを検索

curl --request GET \
  --url 'https://api.box.com/2.0/shared_items#web_links' \
  --header 'Authorization: Bearer <token>' \
  --header 'boxapi: <boxapi>'

{
  "id": "11446498",
  "type": "web_link",
  "etag": "1",
  "url": "https://www.example.com/example/1234",
  "sequence_id": "3",
  "name": "My Bookmark",
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "description": "Example page",
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "id": "12345",
        "type": "folder",
        "etag": "1",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ]
  },
  "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": {
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "download_count": 3,
    "preview_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "vanity_url": "https://acme.app.box.com/v/my_url/",
    "vanity_name": "my_url",
    "access": "open",
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "permissions": {
      "can_download": true,
      "can_preview": true,
      "can_edit": false
    }
  },
  "item_status": "active"
}

このリソースは、バージョン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.

Headers

if-none-match

string

項目が変更されている場合にのみ、その項目を返します。

その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは304 Not Modifiedを返して失敗します。

boxapi

string

required

共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。

このヘッダーの形式は次のようになります。

shared_link=[link]&shared_link_password=[password].

Query Parameters

fields

string[]

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

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

Response

共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、Full版のウェブリンクリソースを返します。

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

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

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

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"

共有リンクのアプリ項目を検索

ウェブリンクの共有リンクを取得

⌘I