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