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

ウェブリンクから共有リンクを削除

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

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ウェブリンクから共有リンクを削除します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

クエリパラメータ

stringクエリ内必須
shared_link

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

リクエスト本文

レスポンス

application/jsonウェブリンク

共有リンクが削除されているウェブリンクのBase版の表示を返します。

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

更新を完了するための権限がユーザーに不足している場合に返されます。

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

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

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

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

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

リクエストの例

cURL
curl -i -X PUT "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": null
     }'
TypeScript Gen
await client.sharedLinksWebLinks.removeSharedLinkFromWebLink(
  webLinkId,
  { sharedLink: createNull() } satisfies RemoveSharedLinkFromWebLinkRequestBody,
  { fields: 'shared_link' } satisfies RemoveSharedLinkFromWebLinkQueryParams,
);
Python Gen
client.shared_links_web_links.remove_shared_link_from_web_link(
    web_link_id, "shared_link", shared_link=create_null()
)
.NET Gen
await client.SharedLinksWebLinks.RemoveSharedLinkFromWebLinkAsync(webLinkId: webLinkId, requestBody: new RemoveSharedLinkFromWebLinkRequestBody() { SharedLink = null }, queryParams: new RemoveSharedLinkFromWebLinkQueryParams(fields: "shared_link"));
Python
client.web_link('12345').remove_shared_link()
.NET
BoxWebLink updatedLink = client.WebLinksManager.DeleteSharedLinkAsync("11111");

レスポンスの例

{
  "etag": "1",
  "id": "12345",
  "shared_link": null,
  "type": "web_link"
}