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

put

https://api.box.com/2.0

/web_links/:web_link_id

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

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

web_link_id stringパス内必須

例12345

ウェブリンクのID。

クエリパラメータ

fields stringクエリ内必須

例shared_link

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

リクエスト本文

shared_link object本文内

例null

この値をnullに設定することで、共有リンクがウェブリンクから削除されます。

レスポンス

200application/jsonウェブリンク

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

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

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

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

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

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

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

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

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

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

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

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

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

put

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

このドキュメント内で一部のAPIを試せるようになりました。

リクエストの例

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
     }'

client.web_link('12345').remove_shared_link()

BoxWebLink updatedLink = client.WebLinksManager.DeleteSharedLinkAsync("11111");

client.webLinks.deleteSharedLink(forWebLink: "11111") { (result: Result<Void, BoxSDKError>) in
    guard case .success = result else {
        print("Error removing weblink shared link")
        return
    }

    print("WebLink shared link removed")
}

レスポンスの例

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