Box Developerドキュメント
ログイン
最新バージョン

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

get
https://api.box.com/2.0
/shared_items

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

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

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須
shared_link=[link]&shared_link_password=[password]

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

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

shared_link=[link]&shared_link_password=[password]

stringヘッダー内省略可能
1

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

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

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

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

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

レスポンス

application/jsonウェブリンク

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

none

If-None-Matchヘッダーがフォルダの現在のetag値と一致する場合は、空のレスポンスを返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。

application/jsonクライアントエラー

予期しないクライアントエラー。

get
共有リンクのウェブリンクを検索
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await userClient.sharedLinksWebLinks.findWebLinkForSharedLink(
  {} satisfies FindWebLinkForSharedLinkQueryParams,
  {
    boxapi: ''.concat(
      'shared_link=',
      webLinkFromApi.sharedLink!.url,
      '&shared_link_password=incorrectPassword',
    ) as string,
  } satisfies FindWebLinkForSharedLinkHeadersInput,
);
Python Gen
user_client.shared_links_web_links.find_web_link_for_shared_link(
    "".join(
        [
            "shared_link=",
            web_link_from_api.shared_link.url,
            "&shared_link_password=incorrectPassword",
        ]
    )
)
.NET Gen
await userClient.SharedLinksWebLinks.FindWebLinkForSharedLinkAsync(queryParams: new FindWebLinkForSharedLinkQueryParams(), headers: new FindWebLinkForSharedLinkHeaders(boxapi: string.Concat("shared_link=", NullableUtils.Unwrap(webLinkFromApi.SharedLink).Url, "&shared_link_password=incorrectPassword")));

レスポンスの例

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "active",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": {
    "access": "open",
    "download_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "permissions": {
      "can_download": true,
      "can_edit": false,
      "can_preview": true
    },
    "preview_count": 3,
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "vanity_name": "my_url",
    "vanity_url": "https://acme.app.box.com/v/my_url/"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "url": "https://www.example.com/example/1234"
}