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

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

get
https://api.box.com/2.0
/web_links/:web_link_id

ウェブリンクの共有リンクの情報を取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ウェブリンクのID。

クエリパラメータ

stringクエリ内必須
shared_link

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

レスポンス

application/jsonウェブリンク

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

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

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

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

ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。

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

file_idが認識されていない形式で指定されている場合に返されます。

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

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

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

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.sharedLinksWebLinks.getSharedLinkForWebLink(webLinkId, {
  fields: 'shared_link',
} satisfies GetSharedLinkForWebLinkQueryParams);
Python Gen
client.shared_links_web_links.get_shared_link_for_web_link(web_link_id, "shared_link")
.NET Gen
await client.SharedLinksWebLinks.GetSharedLinkForWebLinkAsync(webLinkId: webLinkId, queryParams: new GetSharedLinkForWebLinkQueryParams(fields: "shared_link"));
Python
shared_link = client.web_link('12345').get().shared_link
url = shared_link['url']

レスポンスの例

{
  "etag": "1",
  "id": "12345",
  "shared_link": {
    "access": "open",
    "download_count": 0,
    "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
    "effective_access": "open",
    "effective_permission": "can_download",
    "is_password_enabled": false,
    "permissions": {
      "can_download": true,
      "can_edit": false,
      "can_preview": true
    },
    "preview_count": 0,
    "unshared_at": "2020-09-21T10:34:41-07:00",
    "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
    "vanity_name": null,
    "vanity_url": null
  },
  "type": "web_link"
}