Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最新バージョン
フォルダの共有リンクを更新
APIバージョン 2024.0
フォルダの共有リンクを更新します。
レスポンス
application/jsonフォルダ (Full)
更新された共有リンクが追加されているフォルダのBase版の表示を返します。
application/jsonクライアントエラー
権限の組み合わせが正しくない場合に返されます。
application/jsonクライアントエラー
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
application/jsonクライアントエラー
更新を完了するための権限がユーザーに不足している場合に返されます。
application/jsonクライアントエラー
フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。
application/jsonクライアントエラー
folder_idが認識されていない形式で指定されている場合に返されます。
application/jsonクライアントエラー
If-Matchヘッダーがフォルダの現在のetag値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
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
}
}
}'Node/TypeScript v10
await client.sharedLinksFolders.updateSharedLinkOnFolder(
folder.id,
{
sharedLink: {
access:
'collaborators' as UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField,
} satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkField,
} satisfies UpdateSharedLinkOnFolderRequestBody,
{ fields: 'shared_link' } satisfies UpdateSharedLinkOnFolderQueryParams,
);Python v10
client.shared_links_folders.update_shared_link_on_folder(
folder.id,
"shared_link",
shared_link=UpdateSharedLinkOnFolderSharedLink(
access=UpdateSharedLinkOnFolderSharedLinkAccessField.COLLABORATORS
),
).NET v10
await client.SharedLinksFolders.UpdateSharedLinkOnFolderAsync(folderId: folder.Id, requestBody: new UpdateSharedLinkOnFolderRequestBody() { SharedLink = new UpdateSharedLinkOnFolderRequestBodySharedLinkField() { Access = UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.Collaborators } }, queryParams: new UpdateSharedLinkOnFolderQueryParams(fields: "shared_link"));Swift v10
try await client.sharedLinksFolders.updateSharedLinkOnFolder(folderId: folder.id, requestBody: UpdateSharedLinkOnFolderRequestBody(sharedLink: UpdateSharedLinkOnFolderRequestBodySharedLinkField(access: UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.collaborators)), queryParams: UpdateSharedLinkOnFolderQueryParams(fields: "shared_link"))Java v10
client.getSharedLinksFolders().updateSharedLinkOnFolder(folder.getId(), new UpdateSharedLinkOnFolderRequestBody.Builder().sharedLink(new UpdateSharedLinkOnFolderRequestBodySharedLinkField.Builder().access(UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.COLLABORATORS).build()).build(), new UpdateSharedLinkOnFolderQueryParams("shared_link")).NET v6
await client.SharedLinksFolders.UpdateSharedLinkOnFolderAsync(folderId: folder.Id, requestBody: new UpdateSharedLinkOnFolderRequestBody() { SharedLink = new UpdateSharedLinkOnFolderRequestBodySharedLinkField() { Access = UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.Collaborators } }, queryParams: new UpdateSharedLinkOnFolderQueryParams(fields: "shared_link"));Node v4
await client.sharedLinksFolders.updateSharedLinkOnFolder(
folder.id,
{
sharedLink: {
access:
'collaborators' as UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField,
} satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkField,
} satisfies UpdateSharedLinkOnFolderRequestBody,
{ fields: 'shared_link' } satisfies UpdateSharedLinkOnFolderQueryParams,
);レスポンスの例
{
"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": false,
"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": "folder"
}