フォルダから共有リンクを削除

put

https://api.box.com/2.0

/folders/:folder_id

フォルダから共有リンクを削除します。

リクエスト

AuthorizationBearer [ACCESS_TOKEN]

Content-Typeapplication/json

パスパラメータ

folder_id stringパス内必須

例12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

クエリパラメータ

fields stringクエリ内必須

例shared_link

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

リクエスト本文

shared_link object本文内

例null

この値をnullに設定することで、共有リンクがフォルダから削除されます。

レスポンス

200application/jsonFolder (Standard)

共有リンクが削除されているフォルダのBase版の表示を返します。

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

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

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

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

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

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

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

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

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

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

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

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

put

フォルダから共有リンクを削除

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

リクエストの例

curl -i -X PUT "https://api.box.com/2.0/folders/32423234?fields=shared_link" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": null
     }'

BoxFolder folder = new BoxFolder(api, "12345");
BoxFolder.Info info = folder.getInfo();
info.removeSharedLink();
folder.updateInfo(info);

folder_id = '11111'
client.folder(folder_id).remove_shared_link()

client.folders.update('12345', {
  shared_link: null
}).then(folder => {
  // ...
})

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

    print("Folder shared link removed")
}

レスポンスの例

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