最新バージョン
フォルダの共有リンクを取得
APIバージョン 2024.0
フォルダの共有リンクの情報を取得します。
レスポンス
application/jsonフォルダ (Full)
追加の共有リンク情報を含 むフォルダのBase版の表示を返します。
application/jsonクライアントエラー
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
application/jsonクライアントエラー
フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。
application/jsonクライアントエラー
folder_idが認識されていない形式で指定されている場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/folders/32423234?fields=shared_link" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.sharedLinksFolders.getSharedLinkForFolder(folder.id, {
fields: 'shared_link',
} satisfies GetSharedLinkForFolderQueryParams);Python Gen
client.shared_links_folders.get_shared_link_for_folder(folder.id, "shared_link").NET Gen
await client.SharedLinksFolders.GetSharedLinkForFolderAsync(folderId: folder.Id, queryParams: new GetSharedLinkForFolderQueryParams(fields: "shared_link"));Java
BoxFolder folder = new BoxFolder(api, "id");
BoxFolder.Info info = folder.getInfo()
BoxSharedLink link = info.getSharedLink()
String url = link.getUrl()Python
folder_id = '11111'
shared_link = client.folder(folder_id).get().shared_link
url = shared_link['url']Node
client.folders.get('11111', { fields: 'shared_link' })
.then(folder => {
let url = folder.shared_link.url
//...
})iOS
client.folders.getSharedLink(forFolder: "11111") { (result: Result<SharedLink, BoxSDKError>) in
guard case let .success(sharedLink) = result else {
print("Error retrieving folder shared link")
return
}
print("Folder shared link URL is \(sharedLink.url), with \(sharedLink.access) access")
}レスポンスの例
{
"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"
}