Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最新バージョン
ウェブリンクを作成
APIバージョン 2024.0
フォルダ内にウェブリンクオブジェクトを作成します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
リクエスト本文
string本文内省略可能
"Cloud Content Management"ウェブリンクの説明。
string本文内省略可能
"Box Website"ウェブリンクの名前。設定されてない場合は、デフォルトでURLに設定されます。
object本文内
ウェブリンクの作成先となる親フォルダ。
string本文内必須
"0"親フォルダのID。
string本文内必須
"https://box.com"このウェブリンクのリンク先とな るURL。"http://"または"https://"で始まっている必要があります。
リクエストの例
cURL
curl -i -X POST "https://api.box.com/2.0/web_links" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"name": "Cloud Content Management",
"url": "https://box.com",
"parent": {
"id": "0"
}
}'Node/TypeScript v10
await client.webLinks.createWebLink({
url: 'https://www.box.com',
parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField,
name: getUuid(),
description: 'Weblink description',
} satisfies CreateWebLinkRequestBody);Python v10
client.web_links.create_web_link(
"https://www.box.com",
CreateWebLinkParent(id=parent.id),
name=get_uuid(),
description="Weblink description",
).NET v10
await client.WebLinks.CreateWebLinkAsync(requestBody: new CreateWebLinkRequestBody(url: "https://www.box.com", parent: new CreateWebLinkRequestBodyParentField(id: parent.Id)) { Name = Utils.GetUUID(), Description = "Weblink description" });Swift v10
try await client.webLinks.createWebLink(requestBody: CreateWebLinkRequestBody(url: "https://www.box.com", parent: CreateWebLinkRequestBodyParentField(id: parent.id), name: Utils.getUUID(), description: "Weblink description"))Java v10
client.getWebLinks().createWebLink(new CreateWebLinkRequestBody.Builder(url, new CreateWebLinkRequestBodyParentField(parent.getId())).name(name).description(description).build()).NET v6
await client.WebLinks.CreateWebLinkAsync(requestBody: new CreateWebLinkRequestBody(url: "https://www.box.com", parent: new CreateWebLinkRequestBodyParentField(id: parent.Id)) { Name = Utils.GetUUID(), Description = "Weblink description" });Node v4
await client.webLinks.createWebLink({
url: 'https://www.box.com',
parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField,
name: getUuid(),
description: 'Weblink description',
} satisfies CreateWebLinkRequestBody);レスポンスの例
{
"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"
}