フォルダの共有リンクを更新
put
https://api.box.com/2.0
/folders/:folder_id
12345
フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123
の場合、folder_id
は123
です。
Boxアカウントのルートフォルダは常にID 0
で表されます。
shared_link
この項目に返されるshared_link
フィールドを明示的にリクエストします。
"open"
共有リンクのアクセスレベル。これは、リンクを知っている全員 (open
)、会社内のユーザーのみ (company
)、フォルダに招待されたユーザーのみ (collaborators
) のいずれかに制限できます。
設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、{ "shared_link": {} }
のように、access
フィールドを指定せずにshared_link
オブジェクトを渡します。
company
アクセスレベルは、有料アカウントのみで使用できます。
次の値のいずれか1つ: open
,company
,collaborators
"do-n8t-use-this-Password"
共有リンクへのアクセスに必要なパスワード。パスワードをnull
に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。access
がopen
に設定されている場合にのみ、パスワードを設定できます。
true
共有リンクからのファイルのダウンロードが許可されているかどうか。access
がopen
またはcompany
に設定されている場合にのみ設定できます。
false
type
がfolder
の項目の場合、この値はfalse
にしか設定できません。
true
共有リンクからのファイルのプレビューが許可されているかどうか。この値は常にtrue
です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。
"2012-12-12T10:53:43-08:00"
この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。
"my-shared-link"
共有リンクのURLで使用するカスタムバニティ名を定義します (例: https://app.box.com/v/my-shared-link
)。
バニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。
更新された共有リンクが追加されているフォルダのBase版の表示を返します。
Authorization
ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
更新を完了するための権限がユーザーに不足している場合に返されます。
フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。
folder_id
が認識されていない形式で指定されている場合に返されます。
If-Match
ヘッダーがフォルダの現在のetag
値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。
putフォルダの共有リンクを更新
このドキュメント内で一部のAPIを試せるようになりました。