Box Developerドキュメント
ログイン

Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。

最新バージョン

ウェブリンクを更新

put
https://api.box.com/2.0
/web_links/:web_link_id

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ウェブリンクオブジェクトを更新します。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ウェブリンクのID。

リクエスト本文

string本文内省略可能
"Cloud Content Management"

ウェブリンクの新しい説明。

string本文内省略可能
"Box Website"

ウェブリンクの新しい名前。設定されていない場合は、デフォルトでURLに設定されます。

object本文内

ウェブリンクが配置される新しい親フォルダ。これを利用してウェブリンクを別のフォルダに移動します。

string本文内省略可能
"123"

親項目のID。

string本文内省略可能
"12346930"

user_idの入力は省略可能です。user_idが存在する場合、ルート以外のフォルダへの移動は許可されません。user_idが指定されている場合、親フォルダIDはゼロにする必要があります。

object本文内

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

string本文内省略可能
"open"

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

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

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

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

string本文内省略可能
"do-not-use-this-password"

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

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を使用しないでください。

string本文内省略可能
"https://box.com"

ウェブリンクのリンク先となる新しいURL。"http://"または"https://"で始まっている必要があります。

レスポンス

application/jsonウェブリンク

更新されたウェブリンクオブジェクトを返します。

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

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

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

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X PUT "https://api.box.com/2.0/web_links/12345" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "name": "Cloud Content Management"
     }'
Node/TypeScript v10
await client.webLinks.updateWebLinkById(weblink.id, {
  requestBody: {
    name: updatedName,
    sharedLink: {
      access: 'open' as UpdateWebLinkByIdRequestBodySharedLinkAccessField,
      password: password,
    } satisfies UpdateWebLinkByIdRequestBodySharedLinkField,
  } satisfies UpdateWebLinkByIdRequestBody,
} satisfies UpdateWebLinkByIdOptionalsInput);
Python v10
client.web_links.update_web_link_by_id(
    weblink.id,
    name=updated_name,
    shared_link=UpdateWebLinkByIdSharedLink(
        access=UpdateWebLinkByIdSharedLinkAccessField.OPEN, password=password
    ),
)
.NET v10
await client.WebLinks.UpdateWebLinkByIdAsync(webLinkId: weblink.Id, requestBody: new UpdateWebLinkByIdRequestBody() { Name = updatedName, SharedLink = new UpdateWebLinkByIdRequestBodySharedLinkField() { Access = UpdateWebLinkByIdRequestBodySharedLinkAccessField.Open, Password = password } });
Swift v10
try await client.webLinks.updateWebLinkById(webLinkId: weblink.id, requestBody: UpdateWebLinkByIdRequestBody(name: updatedName, sharedLink: UpdateWebLinkByIdRequestBodySharedLinkField(access: UpdateWebLinkByIdRequestBodySharedLinkAccessField.open, password: password)))
Java v10
client.getWebLinks().updateWebLinkById(weblink.getId(), new UpdateWebLinkByIdRequestBody.Builder().name(updatedName).sharedLink(new UpdateWebLinkByIdRequestBodySharedLinkField.Builder().access(UpdateWebLinkByIdRequestBodySharedLinkAccessField.OPEN).password(password).build()).build())
.NET v6
await client.WebLinks.UpdateWebLinkByIdAsync(webLinkId: weblink.Id, requestBody: new UpdateWebLinkByIdRequestBody() { Name = updatedName, SharedLink = new UpdateWebLinkByIdRequestBodySharedLinkField() { Access = UpdateWebLinkByIdRequestBodySharedLinkAccessField.Open, Password = password } });
Node v4
await client.webLinks.updateWebLinkById(weblink.id, {
  requestBody: {
    name: updatedName,
    sharedLink: {
      access: 'open' as UpdateWebLinkByIdRequestBodySharedLinkAccessField,
      password: password,
    } satisfies UpdateWebLinkByIdRequestBodySharedLinkField,
  } satisfies UpdateWebLinkByIdRequestBody,
} satisfies UpdateWebLinkByIdOptionalsInput);

レスポンスの例

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "active",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": {
    "access": "open",
    "download_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "permissions": {
      "can_download": true,
      "can_edit": false,
      "can_preview": true
    },
    "preview_count": 3,
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "vanity_name": "my_url",
    "vanity_url": "https://acme.app.box.com/v/my_url/"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "url": "https://www.example.com/example/1234"
}