ファイルから共有リンクを削除

put

https://api.box.com/2.0

/files/:file_id

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

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

file_id stringパス内必須

例12345

ファイルを表す一意の識別子。

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

クエリパラメータ

fields stringクエリ内必須

例shared_link

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

リクエスト本文

shared_link object本文内

例null

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

レスポンス

200application/jsonファイル (Full)

共有リンクが削除されているファイルの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/files/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": null
     }'

BoxFile file = new BoxFile(api, "12345");
BoxFile.Info info = file.getInfo();
info.removeSharedLink();
file.updateInfo(info);

file_id = '11111'
client.file(file_id).remove_shared_link()

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

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

    print("File shared link removed")
}

レスポンスの例

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