> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# ウェブリンクから共有リンクを削除
> ウェブリンクから共有リンクを削除します。
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 [**Box APIのバージョン管理**](/ja/guides/api-calls/api-versioning-strategy/)を参照してください。
「[Box SDKのバージョニング戦略](/ja/guides/tooling/sdks/sdk-versioning/)について詳しく学ぶ。」
## OpenAPI
````yaml box-openapi-jp.json PUT /web_links/{web_link_id}#remove_shared_link
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box
Platform](https://developer.box.com)では、[Box](https://box.com)内に保存されているコンテンツへのアクセス権限を付与する機能が提供されています。また、ファイルとフォルダの基本操作、会社内のユーザーの管理、リーガルホールドやリテンションポリシーなどの複雑なトピックのためのエンドポイントも提供されています。
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 92c221bf9d
servers:
- url: https://api.box.com/2.0
description: Box Platform APIサーバー。
security:
- OAuth2Security: []
tags:
- name: AI
description: サポート対象のLLMの操作に使用される、一連のエンドポイント。
x-box-tag: ai
- name: AI Studio
description: AI Studioの操作に使用される、一連のエンドポイント。
x-box-tag: ai_studio
- name: アプリ項目の関連付け
x-box-tag: app_item_associations
- name: 承認
description: ユーザー承認プロセスを管理するために使用される、一連のエンドポイント。
x-box-tag: authorization
x-box-priority: true
- name: Box Signリクエスト
description: Box Signリクエストは、署名用ファイルを送信するために使用されます。
x-box-tag: sign_requests
- name: Classifications
description: 分類ラベルは、機密性の高いコンテンツやセキュリティ上の制限が適用されるコンテンツに使用されます。
x-box-tag: classifications
- name: ファイルの分類
description: 分類ラベルは、機密性の高いファイルやセキュリティ上の制限が適用されるファイルに使用されます。
x-box-tag: file_classifications
- name: フォルダの分類
description: 分類ラベルは、機密性の高いフォルダやセキュリティ上の制限が適用されるフォルダに使用されます。
x-box-tag: folder_classifications
- name: Collaborations
description: コラボレーションは、アクセス制限リストと同様に、ユーザーやグループがファイルやフォルダにアクセスする際の権限を定義します。
x-box-tag: user_collaborations
- name: コラボレーション (リスト)
description: ファイル、フォルダ、保留、グループコラボレーションを取得するために使用される、一連のエンドポイント。
x-box-tag: list_collaborations
- name: Collections
description: コレクションを利用して、ファイル、フォルダ、ウェブリンクを1つのフォルダにまとめることなくグループ化できます。
x-box-tag: collections
- name: Comments
description: >-
コメントは、ユーザーがファイルに対して生成するメッセージです。コメントを使用すると、複数のユーザーがファイル上でコラボレーションし、コンテンツに対するフィードバックについて話し合うことができます。
x-box-tag: comments
- name: Device Pinners
description: Device Pinnerを使用すると、どのデバイスでネイティブBoxアプリケーションの使用を許可するかを企業レベルで制御できます。
x-box-tag: device_pinners
- name: ドメインの制限 (ユーザーの除外)
description: 特定の企業に許可されたコラボレーションドメインのリストによって課せられた制限からユーザーを除外できる、一連のエンドポイント。
x-box-tag: collaboration_allowlist_exempt_targets
- name: コラボレーションに対するドメインを制限
description: ユーザーが企業のファイルやフォルダでコラボレーションできるドメインを管理する、一連のエンドポイント。
x-box-tag: collaboration_allowlist_entries
- name: ダウンロード
description: ダウンロードを利用して、ファイルをアプリケーションのサーバーに保存することも、エンドユーザーがブラウザで直接保存することもできます。
x-box-tag: downloads
- name: メールエイリアス
description: メールエイリアスを使用することで、ユーザーのログイン用プライマリメールアドレスに加えて複数のメールアドレスを指定できます。
x-box-tag: email_aliases
- name: Events
description: イベントを利用して、企業内の任意のユーザー (複数可) またはサービスによって実行される操作をアプリケーションが登録できます。
x-box-tag: events
- name: ファイルリクエスト
description: >-
ファイルリクエストを利用すると、任意のユーザーに対してファイルとそれに関連付けられたメタデータを迅速かつ安全にリクエストできます。ユーザーは、既存のファイルリクエストを基にして新しいファイルリクエストを作成できるほか、ファイルリクエストの設定を更新したり、プログラムによってファイルリクエストの有効化、無効化、削除を実行したりできます。
x-box-tag: file_requests
- name: ファイルバージョンリーガルホールド
description: >-
リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。ファイルバージョンリーガルホールドは、特定のファイルバージョンに割り当てられているすべてのポリシーを表します。
x-box-tag: file_version_legal_holds
- name: ファイルバージョンリテンション
description: >-
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。
x-box-tag: file_version_retentions
- name: ファイルバージョン
description: ファイルの特定のバージョンを管理するために使用される、一連のエンドポイント。
x-box-tag: file_versions
- name: Files
description: >-
ファイルは、フォルダとともに、Box
APIの中核を成します。ファイルはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
x-box-tag: files
- name: フォルダロック
description: フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。
x-box-tag: folder_locks
- name: Folders
description: >-
フォルダは、ファイルとともに、Box
APIの中核を成します。フォルダはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
x-box-tag: folders
- name: 統合マッピング
description: 統合マッピングを使用すると、ユーザーはパートナーアプリからのコンテンツがBoxのどこに保存されるかを管理できます。
x-box-tag: integration_mappings
- name: グループメンバーシップ
description: グループメンバーシップは、ユーザーがグループに属していることを示します。
x-box-tag: memberships
- name: Groups
description: 企業内に作成されたグループ。
x-box-tag: groups
- name: Invites
description: 招待は、ユーザーを企業に招待するために使用されます。
x-box-tag: invites
- name: リーガルホールドポリシー
description: >-
リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。
x-box-tag: legal_hold_policies
- name: リーガルホールドポリシー割り当て
description: >-
リーガルホールドポリシー割り当ては、ポリシーとカストディアンの関係です。この場合、カストディアンにはユーザー、フォルダ、ファイル、またはファイルバージョンを指定できます。
x-box-tag: legal_hold_policy_assignments
- name: メタデータカスケードポリシー
description: メタデータカスケードポリシーには、フォルダに適用されているメタデータインスタンスを、そのフォルダ内の項目にどのように適用するかが記載されています。
x-box-tag: metadata_cascade_policies
- name: メタデータインスタンス (ファイル)
description: メタデータインスタンスには、テンプレートとファイル間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
x-box-tag: file_metadata
- name: メタデータインスタンス (フォルダ)
description: メタデータインスタンスには、テンプレートとフォルダ間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
x-box-tag: folder_metadata
- name: メタデータ階層
description: メタデータ階層とは、企業内のメタデータを整理して管理するために役立つ、階層型分類システムです。
x-box-tag: metadata_taxonomies
- name: メタデータテンプレート
description: メタデータテンプレートには、ファイルに割り当てることができる、一連の再利用可能なキー/値ペアが記載されています。
x-box-tag: metadata_templates
- name: 最近使用した項目
description: 最近使用した項目は、ユーザーが最近アクセスしたファイルやフォルダなどの項目を表します。
x-box-tag: recent_items
- name: リテンションポリシー
description: >-
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダや企業全体に割り当てることができます。
x-box-tag: retention_policies
- name: リテンションポリシー割り当て
description: >-
リテンションポリシー割り当ては、ポリシーとフォルダや企業の関係です。割り当てを作成すると、そのフォルダや企業に属するすべてのファイルバージョンにリテンションが適用されます。
x-box-tag: retention_policy_assignments
- name: 検索
description: Box APIを使用すると、ファイルコンテンツ検索クエリを使用してBox内のコンテンツを探すことができます。
x-box-tag: search
- name: セッション終了
description: セッション終了APIを使用すると、グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成できます。
x-box-tag: session_termination
- name: 共有リンク (ファイル)
description: >-
ファイル共有リンクは、Boxに保存されているファイルを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_files
- name: 共有リンク (フォルダ)
description: >-
フォルダ共有リンクは、Boxに保存されているフォルダを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_folders
- name: 共有リンク (ウェブリンク)
description: >-
ファイル用ウェブリンクは、Box内のウェブリンクを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_web_links
- name: 共有リンク (アプリ項目)
description: Boxに保存されているアプリ項目に対して生成されるURL。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_app_items
- name: Shield情報バリア
description: >-
BoxのShield情報バリアは、倫理的境界を定義します。倫理的境界とは、利益相反につながり、結果として倫理的または法的に問題のあるビジネス活動につながる可能性があるやり取りまたは通信を防ぐメカニズムです。
x-box-tag: shield_information_barriers
- name: Shield情報バリアのセグメント
description: >-
Shield情報バリアのセグメントは、ユーザーの定義済みグループを表します。セグメントがグループと異なる点は、ユーザーが所属できるセグメントが1つのみであることです。
x-box-tag: shield_information_barrier_segments
- name: Shield情報バリアのセグメントメンバー
description: Shield情報バリアのセグメントメンバーは、特定のセグメントに割り当てられたユーザーを表します。
x-box-tag: shield_information_barrier_segment_members
- name: Shield情報バリアレポート
description: Shield情報バリアレポートには、情報バリアが有効化されるときに完全に削除される既存のコラボレーションに関する情報が含まれます。
x-box-tag: shield_information_barrier_reports
- name: Shield情報バリアのセグメント制限
description: Shield情報バリアのセグメント制限とは、コンテンツ (ファイルまたはフォルダ) の所有者に基づいて適用されるアクセス制限です。
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Signテンプレート
description: >-
署名テンプレートを使用すると、署名リクエストの作成時に、あらかじめ定義されたBox
Signテンプレートを使用できます。このテンプレートに含まれるプレースホルダには、リクエストの作成時にデータが自動的に入力されます。
x-box-tag: sign_templates
- name: Skills
description: >-
Box
Skillsは、ファイルの基盤となるメタデータを強化することを目的として、Boxにアップロードされたファイルにカスタム処理を実行するための機能です。
x-box-tag: skills
- name: 標準およびZonesのストレージポリシー
description: ストレージポリシー割り当ては、特定の企業内の項目に対するストレージゾーンを表します。
x-box-tag: storage_policies
- name: 標準およびZonesのストレージポリシー割り当て
description: ストレージポリシー割り当ては、ストレージゾーンと割り当てられた項目 (特定のゾーンに保存されているファイルなど) の間の関係を表します。
x-box-tag: storage_policy_assignments
- name: タスク割り当て
description: タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。
x-box-tag: task_assignments
- name: Tasks
description: >-
ユーザーはタスクを使用することで、ファイルのコラボレータに対して、ファイルのレビューや作業の一部の完了をリクエストできます。タスクは、開発者がファイル中心のワークフローを作成するために使用できます。
x-box-tag: tasks
- name: サービス利用規約
description: サービス利用規約を管理するために使用される、一連のエンドポイント。
x-box-tag: terms_of_services
- name: サービス利用規約のユーザーステータス
description: 特定ユーザーのサービス利用規約のステータスを管理するために使用される、一連のエンドポイント。
x-box-tag: terms_of_service_user_statuses
- name: フォルダの移動
description: ユーザーが所有するすべての項目 (ファイル、フォルダ、およびワークフロー) を別のユーザーのアカウントに移動するためのAPI。
x-box-tag: transfer
- name: ごみ箱内のファイル
description: 削除されて現在ごみ箱にあるファイル。
x-box-tag: trashed_files
- name: ごみ箱内のフォルダ
description: 削除されて現在ごみ箱にあるフォルダ。
x-box-tag: trashed_folders
- name: ごみ箱内の項目
description: 削除されて現在ごみ箱にある項目。
x-box-tag: trashed_items
- name: ごみ箱内のウェブリンク
description: 削除されて現在ごみ箱にあるウェブリンク。
x-box-tag: trashed_web_links
- name: アップロード
description: >-
直接ファイルアップロードAPIは最大50 MBのファイルをサポートしており、1回のAPIリクエストですべてのバイナリデータをBox
APIに送信します。
x-box-tag: uploads
- name: アップロード (分割)
description: >-
分割アップロードエンドポイントは20
MB以上のファイルをサポートしており、アプリケーションでファイルを複数のパーツに分割してアップロードすることで、エラーのキャッチと個別のパーツの再送信を詳細に制御できます。
x-box-tag: chunked_uploads
- name: ユーザーのアバター
description: >-
ユーザーのアバターとは、ユーザー画像を表すためにBoxにアップロードされたJPGファイルまたはPNGファイルです。これはユーザーアカウントで表示されます。
x-box-tag: avatars
- name: Users
description: >-
Box APIは、管理対象ユーザーアカウントでログインする実際の従業員や、App
Userを使用して強力な自動化ワークフローを推進するアプリケーションなど、さまざまなユーザーをサポートしています。
x-box-tag: users
- name: 電子すかし (ファイル)
description: >-
電子すかしとは、埋め込みファイルのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、ファイルのアクセス日時が表示されます。
x-box-tag: file_watermarks
- name: 電子すかし (フォルダ)
description: >-
電子すかしとは、埋め込みフォルダのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、フォルダコンテンツのアクセス日時が表示されます。
x-box-tag: folder_watermarks
- name: ウェブリンク
description: ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
x-box-tag: web_links
- name: Webhooks
description: >-
Webhookを使用すると、Boxコンテンツのイベントを監視し、イベントの発生時に任意のURLへの通知を受け取ることができます。たとえば、ファイルがダウンロードされるのを待ち、ダウンロード後に共有リンクを削除するワークフローを作成できます。
x-box-tag: webhooks
- name: ワークフロー (リスト)
description: Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
x-box-tag: workflows
- name: zipダウンロード
description: zipダウンロードは、ファイルやフォルダを含むZIPアーカイブを作成するリクエストが成功したことを表します。
x-box-tag: zip_downloads
externalDocs:
description: Box Developerドキュメント。
url: https://developer.box.com
paths:
/web_links/{web_link_id}#remove_shared_link:
put:
tags:
- 共有リンク (ウェブリンク)
summary: ウェブリンクから共有リンクを削除
description: ウェブリンクから共有リンクを削除します。
operationId: put_web_links_id#remove_shared_link
parameters:
- name: web_link_id
in: path
description: ウェブリンクのID。
required: true
schema:
type: string
example: '12345'
- name: fields
in: query
description: この項目に返される`shared_link`フィールドを明示的にリクエストします。
required: true
schema:
type: string
example: shared_link
requestBody:
content:
application/json:
schema:
type: object
properties:
shared_link:
description: この値を`null`に設定することで、共有リンクがウェブリンクから削除されます。
type: object
example: null
nullable: true
responses:
'200':
description: 共有リンクが削除されているウェブリンクのBase版の表示を返します。
content:
application/json:
schema:
$ref: '#/components/schemas/WebLink'
examples:
default:
value:
id: '12345'
type: web_link
etag: '1'
shared_link: null
'401':
description: '`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。'
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'403':
description: 更新を完了するための権限がユーザーに不足している場合に返されます。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'405':
description: '`file_id`が認識されていない形式で指定されている場合に返されます。'
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'412':
description: >-
`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: 予期しないクライアントエラー。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: ウェブリンクから共有リンクを削除
source: >-
curl -i -X PUT
"https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
-H "authorization: Bearer " \
-d '{
"shared_link": null
}'
- lang: dotnet
label: ウェブリンクから共有リンクを削除
source: >-
await
client.SharedLinksWebLinks.RemoveSharedLinkFromWebLinkAsync(webLinkId:
webLinkId, requestBody: new RemoveSharedLinkFromWebLinkRequestBody()
{ SharedLink = null }, queryParams: new
RemoveSharedLinkFromWebLinkQueryParams(fields: "shared_link"));
- lang: java
label: ウェブリンクから共有リンクを削除
source: >-
client.getSharedLinksWebLinks().removeSharedLinkFromWebLink(webLinkId,
new
RemoveSharedLinkFromWebLinkRequestBody.Builder().sharedLink(null).build(),
new RemoveSharedLinkFromWebLinkQueryParams("shared_link"))
- lang: node
label: ウェブリンクから共有リンクを削除
source: |-
await client.sharedLinksWebLinks.removeSharedLinkFromWebLink(
webLinkId,
{ sharedLink: createNull() } satisfies RemoveSharedLinkFromWebLinkRequestBody,
{ fields: 'shared_link' } satisfies RemoveSharedLinkFromWebLinkQueryParams,
);
- lang: python
label: ウェブリンクから共有リンクを削除
source: |-
client.shared_links_web_links.remove_shared_link_from_web_link(
web_link_id, "shared_link", shared_link=create_null()
)
components:
schemas:
WebLink:
description: |-
ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。
type: object
allOf:
- $ref: '#/components/schemas/WebLink--Mini'
- properties:
parent:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: ウェブリンクが属する親オブジェクト。
description:
description: ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。
type: string
example: Example page
path_collection:
allOf:
- title: パスのコレクション
description: 項目の親フォルダのリスト。
type: object
required:
- total_count
- entries
properties:
total_count:
description: このリスト内のフォルダの数。
type: integer
format: int64
example: 1
nullable: false
entries:
description: この項目の親フォルダ。
type: array
items:
$ref: '#/components/schemas/Folder--Mini'
nullable: false
- description: ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。
- nullable: false
created_at:
description: このファイルがBoxのサーバー上に作成された日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
modified_at:
description: このファイルがBoxサーバー上で最後に更新された日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
trashed_at:
description: このファイルがごみ箱に移動された日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
purged_at:
description: このファイルが完全に削除される日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
created_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: このウェブリンクを作成したユーザー。
modified_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: このウェブリンクを最後に変更したユーザー。
owned_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: このウェブリンクを所有するユーザー。
shared_link:
allOf:
- title: 共有リンク
description: >-
共有リンクを作成すると、Box上のファイルやフォルダに対する読み取り専用アクセスを直接実行できます。
アクセスレベルがopenに設定されている共有リンクの場合は、URLを知っているすべてのユーザーが項目にアクセスでき、アクセスレベルがcompanyまたはcollaboratorsに設定されている共有リンクの場合は、適切に認証されたBoxユーザーのみが項目にアクセスできます。
type: object
required:
- url
- accessed
- effective_access
- effective_permission
- is_password_enabled
- download_count
- preview_count
properties:
url:
description: >-
Box上の項目にアクセスするために使用できるURL。
このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。
このURLは、この共有リンクに対してカスタムの`vanity_url`が 設定されている場合でも動作します。
type: string
format: url
example: https://www.box.com/s/vspke7y05sb214wjokpk
nullable: false
download_url:
description: >-
ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。
フォルダの場合、このプロパティは`null`になります。
type: string
format: url
example: >-
https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg
nullable: true
x-box-premium-feature: true
vanity_url:
description: >-
Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。
type: string
format: url
example: https://acme.app.box.com/v/my_url/
nullable: true
vanity_name:
description: '`vanity_url`フィールドで使用される、共有リンクのカスタム名。'
type: string
example: my_url
nullable: true
access:
description: >-
この共有リンクのアクセスレベル
- `open` - このリンクを知っている全員にこの項目へのアクセスを許可します
- `company` - 同じ会社のユーザーにのみこの項目へのアクセスを許可します
- `collaborators` -
この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します
共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。
type: string
example: open
enum:
- open
- company
- collaborators
nullable: false
effective_access:
description: >-
共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、`access`フィールドの値よりも低いアクセスレベルになることがあります。
type: string
example: company
enum:
- open
- company
- collaborators
nullable: false
effective_permission:
description: >-
この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど)
によって設定される項目の権限の組み合わせの制限が厳しくなります。
type: string
example: can_download
enum:
- can_edit
- can_download
- can_preview
- no_access
nullable: false
unshared_at:
description: このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
nullable: true
is_password_enabled:
description: 共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。
type: boolean
example: true
nullable: false
permissions:
description: >-
このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。
type: object
properties:
can_download:
description: >-
共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。
実際のアクセスレベルが`collaborators`ではなく、`open`または`company`に設定されている場合は、この値を`true`に設定できます。
type: boolean
example: true
nullable: false
can_preview:
description: >-
共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。
この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。
type: boolean
example: true
nullable: false
can_edit:
description: >-
共有リンクからの項目の編集を許可するかどうかを定義します。
`can_download`が`true`で、項目のタイプが`file`の場合のみ、この値も`true`に設定できます。
type: boolean
example: false
nullable: false
required:
- can_download
- can_preview
- can_edit
download_count:
description: この項目がダウンロードされた回数。
type: integer
example: 3
nullable: false
preview_count:
description: この項目がプレビューされた回数。
type: integer
example: 3
nullable: false
- description: この項目の共有リンクオブジェクト。共有リンクがまだ作成されていない場合は、`null`になります。
- nullable: true
item_status:
description: >-
この項目が削除されたかどうか。値には、`active`、`trashed`
(ファイルがごみ箱に移動された場合)、`deleted` (ファイルが完全に削除された場合) があります。
type: string
example: active
enum:
- active
- trashed
- deleted
collections:
description: >-
The collections that this web link belongs to.
For more information, see the [collections
guide](/guides/collections).
type: array
items:
$ref: '#/components/schemas/Collection'
allowed_shared_link_access_levels:
description: >-
The shared link access levels the authenticated user is allowed
to use when creating or updating a shared link for this web
link.
The list depends on item policy and user authorization, so it
may be narrower than the levels available to the owner. An empty
array means no access level is available to this user.
type: array
items:
title: Shared link access level
type: string
description: The access level for a shared link.
example: open
enum:
- open
- company
- collaborators
example:
- open
nullable: false
title: ウェブリンク
x-box-resource-id: web_link
x-box-tag: web_links
x-box-variant: standard
ClientError:
description: 一般的なエラー。
type: object
properties:
type:
description: 値は常に`error`になります。
type: string
example: error
enum:
- error
nullable: false
status:
description: レスポンスのHTTPステータス。
type: integer
format: int32
example: 400
nullable: false
code:
description: Box固有のエラーコード。
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: エラーについての短い説明メッセージ。
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
このエラーに関する追加コンテキストを含む自由形式のオブジェクト。使用できるフィールドは、エンドポイントごとに定義されています。`message`は唯一の例です。
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: このエラーの原因に関する詳細情報にリンクされたURL。
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。
type: string
example: abcdef123456
nullable: false
title: クライアントエラー
x-box-resource-id: client_error
WebLink--Mini:
description: |-
ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。
type: object
allOf:
- $ref: '#/components/schemas/WebLink--Base'
- properties:
url:
description: このウェブリンクが指すURL。
type: string
example: https://www.example.com/example/1234
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
この項目に適用された最新のUser Eventを表す数値の識別子。
これを`GET
/events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser
Eventを除外できます。
たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser
Eventの発生を監視する場合などがこれに該当します。User
Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser
Eventをすべて無視します。
- nullable: false
name:
description: ウェブリンクの名前。
type: string
example: My Bookmark
title: ウェブリンク (Mini)
x-box-resource-id: web_link--mini
x-box-tag: web_links
x-box-variant: mini
Folder--Mini:
description: 他のリソースの下にネストされたときに使用されるファイルバージョンのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/Folder--Base'
- properties:
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
この項目に適用された最新のUser Eventを表す数値の識別子。
これを`GET
/events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser
Eventを除外できます。
たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser
Eventの発生を監視する場合などがこれに該当します。User
Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser
Eventをすべて無視します。
- nullable: false
name:
description: フォルダの名前。
type: string
example: Contracts
nullable: false
title: フォルダ (Mini)
x-box-resource-id: folder--mini
x-box-tag: folders
x-box-variant: mini
User--Mini:
description: 他のリソース内にネストされたときに返される可能性があるユーザーのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/User--Base'
- properties:
name:
description: このユーザーの表示名。
type: string
example: Aaron Levie
maxLength: 50
nullable: false
login:
description: このユーザーのプライマリメールアドレス。
type: string
format: email
example: ceo@example.com
nullable: false
title: ユーザー (Mini)
x-box-resource-id: user--mini
x-box-tag: users
x-box-variant: mini
Collection:
description: |-
ファイルやフォルダなどの項目のコレクション。
現時点で利用可能なコレクションは、`favorites`コレクションのみです。
コレクションのコンテンツは、フォルダのコンテンツと同じ方法で調べることができます。
type: object
properties:
id:
description: このコレクションの一意の識別子。
type: string
example: '11446498'
type:
description: 値は常に`collection`になります。
type: string
example: collection
enum:
- collection
name:
description: コレクションの名前。
type: string
example: Favorites
enum:
- Favorites
collection_type:
description: コレクションのタイプ。これは、コレクションの視覚効果を適切に決定するために使用されます。
type: string
example: favorites
enum:
- favorites
title: Collection
x-box-resource-id: collection
x-box-tag: collections
WebLink--Base:
description: |-
ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。
type: object
properties:
id:
description: このウェブリンクの一意の識別子。
type: string
example: '11446498'
type:
description: 値は常に`web_link`になります。
type: string
example: web_link
enum:
- web_link
etag:
description: このウェブリンクのエンティティタグ。`If-Match`ヘッダーで使用します。
type: string
example: '1'
required:
- id
- type
title: ウェブリンク (Base)
x-box-resource-id: web_link--base
x-box-tag: web_links
x-box-variant: base
x-box-variants:
- base
- mini
- standard
Folder--Base:
description: 最も基本的なフォルダのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。
type: object
properties:
id:
description: >-
フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。
type: string
example: '12345'
nullable: false
etag:
description: >-
このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合)
にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。
type: string
example: '1'
nullable: true
type:
description: 値は常に`folder`になります。
type: string
example: folder
enum:
- folder
nullable: false
required:
- id
- type
title: フォルダ (Base)
x-box-resource-id: folder--base
x-box-tag: folders
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
User--Base:
description: 他のリソース内にネストされたときに使用されるユーザーのMini版の表示。
type: object
properties:
id:
description: このユーザーの一意の識別子。
type: string
example: '11446498'
type:
description: 値は常に`user`になります。
type: string
example: user
enum:
- user
nullable: false
required:
- type
- id
title: ユーザー (Base)
x-box-resource-id: user--base
x-box-tag: users
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
securitySchemes:
OAuth2Security:
type: oauth2
description: >-
The access token received from the authorization server in the OAuth 2.0
flow.
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Boxに格納されているすべてのファイルとフォルダの読み取り
root_readwrite: Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み
manage_app_users: App Userのプロビジョニングと管理
manage_managed_users: 管理対象ユーザーのプロビジョニングと管理
manage_groups: 企業のグループの管理
manage_webhook: APIを使用したプログラムによるWebhookの作成
manage_enterprise_properties: Enterpriseのプロパティを管理
manage_data_retention: データリテンションポリシーの管理
manage_legal_hold: リーガルホールドの管理
````