ウェブリンクを取得
ウェブリンクに関する情報を取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345ウェブリンクのID。
リクエストヘッダー
stringヘッダー内省略可能
shared_link=[link]&shared_link_password=[password]この項目の共有リンクのURLと省略可能なパスワード。
このヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。
shared_link=[link]形式を使用するか、パスワードが必要な場合はshared_link=[link]&shared_link_password=[password]を使用します。
このヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/web_links/12345" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.webLinks.getWebLinkById(weblink.id);Python Gen
client.web_links.get_web_link_by_id(weblink.id).NET Gen
await client.WebLinks.GetWebLinkByIdAsync(webLinkId: weblink.Id);Java
BoxWebLink webLink = new BoxWebLink(api, id);
BoxWebLink.Info webLinkInfo = webLink.getInfo();Python
web_link = client.web_link(web_link_id='12345').get()
print(f'Web Link ID is {web_link.id} and its type is {web_link.type}').NET
BoxWebLink link = await client.WebLinksManager.GetWebLinkAsync("11111");Node
client.weblinks.get('11111')
.then(weblink => {
/* weblink -> {
type: 'web_link',
id: '11111',
sequence_id: '0',
etag: '0',
name: 'Box Website!',
url: 'https://www.box.com',
created_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
created_at: '2015-05-07T15:00:01-07:00',
modified_at: '2015-05-07T15:00:01-07:00',
parent:
{ type: 'folder',
id: '22222',
sequence_id: '1',
etag: '1',
name: 'Bookmarks' },
description: 'Enterprise Cloud Content Management',
item_status: 'active',
trashed_at: null,
purged_at: null,
shared_link: null,
path_collection:
{ total_count: 2,
entries:
[ { type: 'folder',
id: '0',
sequence_id: null,
etag: null,
name: 'All Files' },
{ type: 'folder',
id: '22222',
sequence_id: '1',
etag: '1',
name: 'Bookmarks' } ] },
modified_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
owned_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' } }
*/
});iOS
client.webLinks.get(webLinkId: "11111", fields: ["name", "created_at"]) { (result: Result<WebLink, BoxSDKError>) in
guard case let .success(webLink) = result else {
print("Error retrieving web link information")
return
}
print("WebLink \(webLink.name) was created at \(webLink.createdAt)")
}レスポンスの例
{
"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": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
],
"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"
}