Box Developerドキュメント
ログイン
最新バージョン

ファイルの共有リンクを更新

put
https://api.box.com/2.0
/files/:file_id

ファイルの共有リンクを更新します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

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

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

クエリパラメータ

stringクエリ内必須
shared_link

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

リクエスト本文

object本文内

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

string本文内省略可能
"open"

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

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

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

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

string本文内省略可能
"do-n8t-use-this-Password"

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

object本文内
boolean本文内省略可能
true

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

boolean本文内省略可能
true

共有リンクからのファイルの編集が許可されているかどうか。accessがopenまたはcompanyに設定されている場合にのみ設定できます。can_downloadがtrueの場合、この値もtrueにしか設定できません。

boolean本文内省略可能
true

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

string (date-time)本文内省略可能
"2012-12-12T10:53:43-08:00"

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

string本文内省略可能
"my-shared-link"

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

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

レスポンス

application/jsonファイル (Full)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

put
ファイルの共有リンクを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X PUT "https://api.box.com/2.0/files/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
         }
       }
     }'
TypeScript Gen
await client.sharedLinksFiles.updateSharedLinkOnFile(
  fileId,
  {
    sharedLink: {
      access:
        'collaborators' as UpdateSharedLinkOnFileRequestBodySharedLinkAccessField,
    } satisfies UpdateSharedLinkOnFileRequestBodySharedLinkField,
  } satisfies UpdateSharedLinkOnFileRequestBody,
  { fields: 'shared_link' } satisfies UpdateSharedLinkOnFileQueryParams,
);
Python Gen
client.shared_links_files.update_shared_link_on_file(
    file_id,
    "shared_link",
    shared_link=UpdateSharedLinkOnFileSharedLink(
        access=UpdateSharedLinkOnFileSharedLinkAccessField.COLLABORATORS
    ),
)
.NET Gen
await client.SharedLinksFiles.UpdateSharedLinkOnFileAsync(fileId: fileId, requestBody: new UpdateSharedLinkOnFileRequestBody() { SharedLink = new UpdateSharedLinkOnFileRequestBodySharedLinkField() { Access = UpdateSharedLinkOnFileRequestBodySharedLinkAccessField.Collaborators } }, queryParams: new UpdateSharedLinkOnFileQueryParams(fields: "shared_link"));
Java
BoxFile file = new BoxFile(api, "id");
BoxSharedLinkRequest sharedLinkRequest = new BoxSharedLinkRequest()
    .access(OPEN)
    .permissions(true, true);
BoxSharedLink sharedLink = file.createSharedLink(sharedLinkRequest);

レスポンスの例

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