フォルダの共有リンクを更新

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本文内

更新する共有リンクの設定。

shared_link.access string本文内省略可能

例"open"

共有リンクのアクセスレベル。これは、リンクを知っている全員 (open)、会社内のユーザーのみ (company)、フォルダに招待されたユーザーのみ (collaborators) のいずれかに制限できます。

設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、{ "shared_link": {} }のように、accessフィールドを指定せずにshared_linkオブジェクトを渡します。

companyアクセスレベルは、有料アカウントのみで使用できます。

次の値のいずれか1つ: open,company,collaborators

shared_link.password string本文内省略可能

例"do-n8t-use-this-Password"

共有リンクへのアクセスに必要なパスワード。パスワードをnullに設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。accessがopenに設定されている場合にのみ、パスワードを設定できます。

shared_link.permissions object本文内

permissions.can_download boolean本文内省略可能

例true

共有リンクからのファイルのダウンロードが許可されているかどうか。accessがopenまたはcompanyに設定されている場合にのみ設定できます。

permissions.can_edit boolean本文内省略可能

例false

typeがfolderの項目の場合、この値はfalseにしか設定できません。

permissions.can_preview boolean本文内省略可能

例true

共有リンクからのファイルのプレビューが許可されているかどうか。この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

shared_link.unshared_at string (date-time)本文内省略可能

例"2012-12-12T10:53:43-08:00"

この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。

shared_link.vanity_name string本文内省略可能

例"my-shared-link"

共有リンクのURLで使用するカスタムバニティ名を定義します (例: https://app.box.com/v/my-shared-link)。

バニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。

レスポンス

200application/jsonフォルダ (Full)

更新された共有リンクが追加されているフォルダのBase版の表示を返します。

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

権限の組み合わせが正しくない場合に返されます。

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

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

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

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

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

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

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

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

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

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

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

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

put

フォルダの共有リンクを更新

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

ログイン

リクエストの例

cURL

curl -i -X PUT "https://api.box.com/2.0/folders/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": {
         "access": "open",
         "password": "mypassword",
         "unshared_at": "2012-12-12T10:53:43-08:00",
         "permissions": {
           "can_download": false
         }
       }
     }'

Java

BoxFolder folder = new BoxFolder(api, "id");
BoxSharedLinkRequest sharedLinkRequest = new BoxSharedLinkRequest()
    .access(OPEN)
    .permissions(true, true);

BoxSharedLink sharedLink = folder.createSharedLink(sharedLinkRequest);

レスポンスの例

{
  "id": "12345",
  "type": "folder",
  "etag": "1",
  "shared_link": {
    "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
    "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
    "vanity_url": null,
    "vanity_name": null,
    "effective_access": "open",
    "effective_permission": "can_download",
    "is_password_enabled": false,
    "unshared_at": "2020-09-21T10:34:41-07:00",
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_preview": true,
      "can_download": true,
      "can_edit": false
    }
  }
}