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

put

https://api.box.com/2.0

/folders/:folder_id/

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

Request

AuthorizationBearer [ACCESS_TOKEN]

Content-Typeapplication/json

Path Parameters

folder_id stringin pathrequired

example12345

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

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

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

Query Parameters

fields stringin queryrequired

exampleshared_link

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

Request Body

shared_link objectin body

examplenull

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

Response

200application/jsonFolder (Standard)

共有リンクが削除されている、フォルダの基本レプリゼンテーションを返します。

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

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

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

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

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

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

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

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

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

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

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

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

put

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

You can now try out some of our APIs live, right here in the documentation.

Request Example

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

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

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

Response Example

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