> ## 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.
# ファイルをアップロード
> 小さいファイルをBoxにアップロードします。ファイルサイズが50 MBを超える場合は、分割アップロードAPIを使用することをお勧めします。
本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。
このリソースは、バージョン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 POST /files/content
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: 056413ec44
servers:
- url: https://api.box.com/2.0
description: Box Platform APIサーバー。
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: アプリ項目の関連付け
x-box-tag: app_item_associations
- name: 承認
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Signリクエスト
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: ファイルの分類
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: フォルダの分類
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: コラボレーション (リスト)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device Pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: ドメインの制限 (ユーザーの除外)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: コラボレーションに対するドメインを制限
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: ダウンロード
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: メールエイリアス
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: ファイルリクエスト
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: ファイルバージョンリーガルホールド
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: ファイルバージョンリテンション
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: ファイルバージョン
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: フォルダロック
description: フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: 統合マッピング
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: グループメンバーシップ
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: リーガルホールドポリシー
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: リーガルホールドポリシー割り当て
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: メタデータカスケードポリシー
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: メタデータインスタンス (ファイル)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: メタデータインスタンス (フォルダ)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: メタデータ階層
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: メタデータテンプレート
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: 最近使用した項目
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: リテンションポリシー
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: リテンションポリシー割り当て
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: 検索
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: セッション終了
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: 共有リンク (ファイル)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: 共有リンク (フォルダ)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: 共有リンク (ウェブリンク)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: 共有リンク (アプリ項目)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield情報バリア
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield情報バリアのセグメント
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield情報バリアのセグメントメンバー
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield情報バリアレポート
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield情報バリアのセグメント制限
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Signテンプレート
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: 標準およびZonesのストレージポリシー
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: 標準およびZonesのストレージポリシー割り当て
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: タスク割り当て
description: タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: サービス利用規約
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: サービス利用規約のユーザーステータス
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: フォルダの移動
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: ごみ箱内のファイル
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: ごみ箱内のフォルダ
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: ごみ箱内の項目
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: ごみ箱内のウェブリンク
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: アップロード
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: アップロード (分割)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: ユーザーのアバター
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: 電子すかし (ファイル)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: 電子すかし (フォルダ)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: ウェブリンク
description: ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: ワークフロー (リスト)
description: Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
x-box-tag: workflows
- name: zipダウンロード
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developerドキュメント。
url: https://developer.box.com
paths:
/files/content:
post:
tags:
- アップロード
summary: ファイルをアップロード
description: >-
小さいファイルをBoxにアップロードします。ファイルサイズが50 MBを超える場合は、分割アップロードAPIを使用することをお勧めします。
本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP
`400`エラーと`metadata_after_file_contents`エラーコードが返されます。
operationId: post_files_content
parameters:
- name: fields
in: query
description: >-
レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
required: false
schema:
type: array
items:
type: string
example:
- id
- type
- name
explode: false
- name: content-md5
in: header
description: ファイルが転送中に破損していないことを確認するための、ファイルのSHA1ハッシュを含むヘッダー (省略可)。
required: false
schema:
type: string
example: 134b65991ed521fcfe4724b7d814ab8ded5185dc
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
attributes:
description: >-
アップロードされるファイルの追加の属性。主に名前と親フォルダ。これらの属性はマルチパートリクエスト本文に含まれており、JSON形式です。
本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP
`400`エラーと`metadata_after_file_contents`エラーコードが返されます。
type: object
properties:
name:
description: >-
ファイルの名前。
ファイル名はその親フォルダ内で一意である必要があります。名前のチェックでは大文字と小文字が区別されないため、`New
File`という名前のファイルは、`new
file`というフォルダがすでに含まれている親フォルダ内に作成できません。
type: string
example: Photo.png
parent:
description: ファイルのアップロード先の親フォルダ。
type: object
properties:
id:
description: 親フォルダのID。ユーザーのルートフォルダを指定するには、`0`を使用します。
type: string
example: '124132'
required:
- id
content_created_at:
description: |-
ファイルが最初に作成された日時を定義します。
設定されていない場合は、アップロード日時が使用されます。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
content_modified_at:
description: |-
ファイルが最後に変更された日時を示します。
設定されていない場合は、アップロード日時が使用されます。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
required:
- name
- parent
file:
description: >-
Boxにアップロードするファイルのコンテンツ。
本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP
`400`エラーと`metadata_after_file_contents`エラーコードが返されます。
type: string
format: binary
required:
- attributes
- file
responses:
'201':
description: リスト内の新しいファイルオブジェクトを返します。
content:
application/json:
schema:
$ref: '#/components/schemas/Files'
'400':
description: |-
パラメータが不足しているか無効の場合はエラーを返します。
- `bad_request` - パラメータが指定されていないか誤っている場合に返されます。
- `item_name_too_long` - フォルダ名が長すぎる場合に返されます。
- `item_name_invalid` - フォルダ名に無効な文字が含まれている場合に返されます。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: 親フォルダが存在しない場合、またはユーザーが親フォルダへのアクセスを承認されていない場合はエラーを返します。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'409':
description: ファイルがすでに存在する場合、またはアカウントのディスク容量が不足している場合は、エラーを返します。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: 予期しないクライアントエラー。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
servers:
- url: https://upload.box.com/api/2.0
description: ファイルアップロードに使用するサーバー。
x-codeSamples:
- lang: curl
label: ファイルをアップロード
source: |-
curl -i -X POST "https://upload.box.com/api/2.0/files/content" \
-H "authorization: Bearer " \
-H "content-type: multipart/form-data" \
-F attributes='{"name":"Contract.pdf", "parent":{"id":"11446498"}}' \
-F file=@
- lang: dotnet
label: ファイルをアップロード
source: >-
await client.Uploads.UploadFileAsync(requestBody: new
UploadFileRequestBody(attributes: new
UploadFileRequestBodyAttributesField(name: newFileName, parent: new
UploadFileRequestBodyAttributesParentField(id: "0")), file:
fileContentStream));
- lang: swift
label: ファイルをアップロード
source: >-
// Create InputStream for a file based on URL
guard let fileStream = InputStream(url: URL(string:
"")!) else {
fatalError("Could not read a file")
}
// Create a request body with the required parameters
let requestBody = UploadFileRequestBody(
attributes: UploadFileRequestBodyAttributesField(
name: "filename.txt",
parent: UploadFileRequestBodyAttributesParentField(id: "0")
),
file: fileStream
)
// Call uploadFile method
let files = try await client.uploads.uploadFile(requestBody:
requestBody)
// Print some data from the reponse
if let file = files.entries?[0] {
print("File uploaded with id \(file.id), name \(file.name!)")
}
- lang: java
label: ファイルをアップロード
source: >-
client.getUploads().uploadFile(new UploadFileRequestBody(new
UploadFileRequestBodyAttributesField(newFileName, new
UploadFileRequestBodyAttributesParentField("0")),
fileContentStream))
- lang: node
label: ファイルをアップロード
source: |-
const fs = require('fs');
const attrs = { name: 'filename.txt', parent: { id: '0' } };
const body = {
attributes: attrs,
file: fs.createReadStream('filename.txt'),
};
const files = await client.uploads.uploadFile(body);
const file = files.entries[0];
console.log(`File uploaded with id ${file.id}, name ${file.name}`);
- lang: python
label: ファイルをアップロード
source: |-
client.uploads.upload_file(
UploadFileAttributes(
name=new_file_name, parent=UploadFileAttributesParentField(id="0")
),
file_content_stream,
)
components:
schemas:
Files:
description: ファイルのリスト。
type: object
properties:
total_count:
description: ファイルの数。
type: integer
format: int64
example: 1
entries:
description: ファイルのリスト。
type: array
items:
$ref: '#/components/schemas/File--Full'
title: Files
x-box-resource-id: files
x-box-tag: files
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
File--Full:
description: 任意のファイルAPIエンドポイントからデフォルトで返される可能性があるファイルのFull版の表示。
type: object
allOf:
- $ref: '#/components/schemas/File'
- properties:
version_number:
description: このファイルのバージョン番号。
type: string
example: '1'
comment_count:
description: このファイルに関するコメントの数。
type: integer
example: 10
permissions:
allOf:
- type: object
description: このファイルに対して認証済みユーザーが持っている権限。
required:
- can_annotate
- can_comment
- can_preview
- can_upload
- can_view_annotations_all
- can_view_annotations_self
allOf:
- type: object
description: この項目に対して認証済みユーザーが持っている権限。
required:
- can_delete
- can_download
- can_invite_collaborator
- can_rename
- can_set_share_access
- can_share
properties:
can_delete:
description: 現在のユーザーがこの項目を削除できるかどうかを指定します。
type: boolean
example: true
nullable: false
can_download:
description: 現在のユーザーがこの項目をダウンロードできるかどうかを指定します。
type: boolean
example: true
nullable: false
can_invite_collaborator:
description: >-
現在のユーザーがこの項目でのコラボレーションに新しいユーザーを招待できるかどうかと、この項目ですでにコラボレーションしているユーザーのロールを更新できるかどうかを指定します。
type: boolean
example: true
nullable: false
can_rename:
description: ユーザーがこの項目の名前を変更できるかどうかを指定します。
type: boolean
example: true
nullable: false
can_set_share_access:
description: ユーザーがこの項目の既存の共有リンクのアクセスレベルを変更できるかどうかを指定します。
type: boolean
example: true
nullable: false
can_share:
description: ユーザーがこの項目の共有リンクを作成できるかどうかを指定します。
type: boolean
example: true
nullable: false
- properties:
can_annotate:
description: ユーザーがこのファイルに注釈を付けられるかどうかを指定します。
type: boolean
example: true
nullable: false
can_comment:
description: ユーザーがこのファイルにコメントを追加できるかどうかを指定します。
type: boolean
example: true
nullable: false
can_preview:
description: ユーザーがこのファイルをプレビューできるかどうかを指定します。
type: boolean
example: true
nullable: false
can_upload:
description: ユーザーがこのファイルの新しいバージョンをアップロードできるかどうかを指定します。
type: boolean
example: true
nullable: false
can_view_annotations_all:
description: ユーザーに対してこのファイルに付けられたすべての注釈を表示するかどうかを指定します。
type: boolean
example: true
nullable: false
can_view_annotations_self:
description: ユーザーに対して自分がファイルに付けた注釈を表示するかどうかを指定します。
type: boolean
example: true
nullable: false
can_apply_watermark:
description: ユーザーがこのファイルに電子すかしを適用できるかどうかを指定します。
type: boolean
example: true
nullable: false
- description: このファイルに対して現在のユーザーが持っている権限について説明します。
- nullable: false
tags:
allOf:
- type: array
example:
- approved
items:
type: string
minItems: 1
maxItems: 100
description: |-
この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。
タグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。
タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。
- nullable: false
lock:
allOf:
- title: Lock
type: object
description: >-
ファイルで保持されているロック。ロックにより、ロックを作成したユーザー以外は、ファイルを移動、名前変更、および変更できません。
properties:
id:
description: このロックの一意の識別子。
type: string
example: '11446498'
type:
description: 値は常に`lock`になります。
type: string
example: lock
enum:
- lock
created_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: ロックを作成したユーザー。
created_at:
description: このロックが作成された日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
expired_at:
description: このロックが期限切れになる日時。過去の日時になる場合もあります。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
is_download_prevented:
description: ロック中でもファイルのダウンロードを許可するかどうか。
type: boolean
example: true
app_type:
description: >-
ロックを管理しているのがユーザーではなくアプリケーションの場合、このフィールドは、ロックを保持しているアプリケーションの種類を示します。これはオープンな列挙型で、今後、値の追加により拡張される可能性があります。
type: string
example: office_wopiplus
enum:
- gsuite
- office_wopi
- office_wopiplus
- other
nullable: true
- description: このファイルで保持されているロック。ロックが存在しない場合は`null`になるか、過去のタイムスタンプになります。
nullable: true
extension:
description: このファイルのファイル拡張子 (省略可) を示します。デフォルトでは、空の文字列に設定されます。
type: string
example: pdf
is_package:
description: >-
ファイルがパッケージかどうかを示します。パッケージはMacアプリケーションで一般的に使用され、iWorkファイルを含めることができます。
type: boolean
example: true
expiring_embed_link:
allOf:
- title: 有効期限付き埋め込みリンク
type: object
description: 有効期限付きのBox Embedリンク。
allOf:
- type: object
description: アクセストークンの基本情報。
properties:
access_token:
description: リクエストされたアクセストークン。
type: string
format: token
example: >-
c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ
expires_in:
description: このトークンが期限切れになるまでの秒数。
type: integer
format: int64
example: 3600
token_type:
description: 返されるアクセストークンのタイプ。
type: string
example: bearer
enum:
- bearer
restricted_to:
description: >-
このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど)
のリストと、各リソースで許可されるスコープが提供されます。
type: array
items:
$ref: '#/components/schemas/ResourceScope'
- properties:
url:
description: >-
このファイルの実際の有効期限付き埋め込みURL。このオブジェクトで指定されたファイルIDとアクセストークンから作成されます。
type: string
format: url
example: https://cloud.app.box.com/preview/expiring_embed/...
- description: >-
このフィールドをリクエストすると、`iframe`に埋め込まれたプレビューセッション用の有効期限付きBox Embed
URLが作成されます。
このURLは60秒後に有効期限切れとなり、セッションはその60分後に有効期限切れとなります。
一部のファイルタイプは、これらの埋め込みURLでサポートされていません。Box
Embedはモバイルブラウザ向けに最適化されていないため、モバイルデバイス用に設計されたウェブエクスペリエンスでは使用しないでください。多くのUI
Element (**ダウンロード**オプションや**印刷**オプションなど)
はモバイルブラウザに表示されない可能性があります。
watermark_info:
allOf:
- type: object
description: この項目に適用された電子すかしに関する詳細。
properties:
is_watermarked:
description: この項目に電子すかしが適用されているかどうかを指定します。
type: boolean
example: true
nullable: false
is_watermark_inherited:
description: 電子すかしが階層のいずれかの親フォルダから継承されるかどうかを指定します。
type: boolean
example: false
nullable: false
is_watermarked_by_access_policy:
description: 電子すかしがアクセスポリシーで適用されるかどうかを指定します。
type: boolean
example: false
nullable: false
- description: このファイルに適用された電子すかしに関する詳細。
is_accessible_via_shared_link:
description: 直接共有リンクまたは親フォルダへの共有リンクを使用してファイルにアクセスできるかどうかを指定します。
type: boolean
example: true
allowed_invitee_roles:
description: このファイルを共有するときに招待できるユーザーの役割タイプのリスト。
type: array
items:
type: string
enum:
- editor
- viewer
- previewer
- uploader
- previewer uploader
- viewer uploader
- co-owner
example:
- editor
nullable: false
is_externally_owned:
description: このファイルが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。
type: boolean
example: true
nullable: false
has_collaborations:
description: このファイルに他のコラボレータが存在するかどうかを指定します。
type: boolean
example: true
nullable: false
metadata:
allOf:
- title: 項目メタデータインスタンス
type: object
description: >-
`scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。
ファイルまたはフォルダのメタデータにアクセスするには、最初にメタデータエンドポイントを使用して、会社で使用できるメタデータテンプレートを特定します。
その後、`fields`クエリパラメータを指定して`GET /files/:id`または`GET
/folder/:id`エンドポイントを使用すると、IDを指定してメタデータを取得できます。
特定の`scope`および`templateKey`のメタデータインスタンスをリクエストするには、`fields`パラメータに`metadata..`の形式を使用してください。
たとえば、`?fields=metadata.enterprise_27335.marketingCollateral`のようになります。
example:
enterprise_27335:
marketingCollateral:
$canEdit: true
$id: 01234500-12f1-1234-aa12-b1d234cb567e
$parent: folder_59449484661
$scope: enterprise_27335
$template: marketingCollateral
$type: properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0
$typeVersion: 2
$version: 1
additionalProperties:
type: object
description: '`scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。'
example:
marketingCollateral:
$canEdit: true
$id: 01234500-12f1-1234-aa12-b1d234cb567e
$parent: folder_59449484661
$scope: enterprise_27335
$template: marketingCollateral
$type: properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0
$typeVersion: 2
$version: 1
additionalProperties:
$ref: '#/components/schemas/Metadata--Full'
- description: >-
このファイルに追加されたメタデータインスタンスを含むオブジェクト。
各メタデータインスタンスは、その`scope`と`templateKey`によって一意に識別されます。各ファイルに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとして`templateKey`が指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとして`scope`が指定されているオブジェクト内にネストされます。
expires_at:
description: ファイルが自動的に削除される日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
representations:
allOf:
- title: Representations
description: ファイルレプリゼンテーションのリスト。
type: object
properties:
entries:
description: ファイルのリスト。
type: array
items:
type: object
description: ファイルレプリゼンテーション。
properties:
content:
description: レプリゼンテーションを実際に取得するために使用できるURLを含むオブジェクト。
properties:
url_template:
description: >-
レプリゼンテーションを取得するために使用できるダウンロードURL。このエンドポイントに対しては必ず認証済みAPIコールを行ってください。
このURLはテンプレートであるため、`{+asset_path}`を実際のパスに置き換える必要があります。通常、ページ付けが行われていないレプリゼンテーションの場合は、空の文字列に置き換えることができます。
ページ割りされたレプリゼンテーションの場合は、`1.pdf`など、リクエストするページにファイル拡張子を付けた文字列で`{+asset_path}`を置き換えます。
ダウンロードURLをリクエストする際には、以下の追加クエリパラメータを渡すことができます。
- `set_content_disposition_type` -
配置タイプとして`inline`または`attachment`のいずれかを指定してAPIレスポンスの`Content-Disposition`ヘッダーを設定します。このパラメータを指定しない場合、レスポンスに`Content-Disposition`ヘッダーは含まれません。
- `set_content_disposition_filename` -
`Content-Disposition`ヘッダーで使用するレプリゼンテーションのファイル名をアプリケーションで定義できます。定義しない場合は、Boxのソースファイル名から派生したファイル名とレプリゼンテーション拡張子の組み合わせがファイル名になります。
type: string
example: >-
https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567
type: object
info:
description: このレプリゼンテーションの詳細を取得するために使用できるURLを含むオブジェクト。
type: object
properties:
url:
description: >-
このファイルレプリゼンテーションの詳細を取得するために使用できるAPI
URL。このエンドポイントに対しては必ず認証済みAPIコールを行ってください。
type: string
example: >-
https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048
properties:
description: このプレゼンテーションのサイズとタイプを含むオブジェクト。
type: object
properties:
dimensions:
type: string
format: x
example: 2048x2048
description: このレプリゼンテーションの幅と高さ。
paged:
type: string
example: 'true'
description: レプリゼンテーションが複数のページで構成されているかどうかを示します。
thumb:
type: string
example: 'true'
description: そのレプリゼンテーションをファイルのサムネイルとして使用できるかどうかを示します。
representation:
description: 返されたレプリゼンテーションのファイルタイプを示します。
type: string
example: png
status:
description: このレプリゼンテーションのステータスを含むオブジェクト。
type: object
properties:
state:
description: >-
レプリゼンテーションのステータス。
- `success`はそのレプリゼンテーションが表示可能な状態であることを示します。
- `viewable`は視聴可能な動画であることを示します。
-
`pending`はそのレプリゼンテーションがこれから生成されることを示します。ステータスを再確認するにはこのエンドポイントを再試行します。
-
`none`はリクエストされたときにレプリゼンテーションが再作成されることを示します。この生成をトリガーするには、`info`オブジェクトで定義されたURLをリクエストします。
type: string
example: success
enum:
- success
- viewable
- pending
- none
- description: >-
アプリケーション内でファイルのプレースホルダを表示するために使用できるレプリゼンテーションのリスト。デフォルトでは、すべてのレプリゼンテーションが返されるため、`x-rep-hints`ヘッダーを使用して目的のレプリゼンテーションをさらにカスタマイズすることをお勧めします。
classification:
allOf:
- type: object
description: 項目に適用される分類。
properties:
name:
description: 分類の名前。
type: string
example: Top Secret
definition:
description: この分類の意味の説明。
type: string
example: Content that should not be shared outside the company.
color:
description: >-
ユーザーインターフェースでの分類ラベルの表示に使用される色。色は、Boxウェブアプリで分類を作成した管理者または共同管理者によって定義されます。
type: string
example: '#FF0000'
- description: このファイルに適用された分類に関する詳細
- nullable: true
uploader_display_name:
allOf:
- title: アップローダーの表示名
type: string
example: Ellis Wiggins
nullable: false
description: >-
ファイルをアップロードしたユーザーの表示名。ほとんどの場合、これはアップロード時点でログインしているユーザーの名前です。
このファイルのアップロードに、ユーザーに対してメールアドレスの入力を要求するファイルリクエストフォームが使用された場合、このフィールドにはそのメールアドレスが設定されます。メールアドレスがファイルリクエストフォームで要求されなかった場合、このフィールドは、`File
Request`という値を返すように設定されます。
メールアドレスが指定されなかったその他すべての匿名のケースでは、このフィールドの値がデフォルトで`Someone`になります。
disposition_at:
description: 特定のファイルのリテンションの有効期限のタイムスタンプ。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
shared_link_permission_options:
description: このファイルを共有するときに招待できるユーザーの役割タイプのリスト。
type: array
items:
type: string
enum:
- can_preview
- can_download
- can_edit
example:
- can_preview
nullable: true
is_associated_with_app_item:
description: >-
ファイルまたはファイルの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのファイルに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。
type: boolean
example: true
nullable: false
title: ファイル (Full)
x-box-resource-id: file--full
x-box-tag: files
x-box-variant: full
File:
description: 任意のファイルAPIエンドポイントからデフォルトで返されるファイルのStandard版の表示。
type: object
allOf:
- $ref: '#/components/schemas/File--Mini'
- properties:
description:
description: >-
このファイルの説明
(省略可)。説明が255文字を超える場合は、最初の255文字がファイルの説明として設定され、残りは無視されます。
type: string
example: Contract for Q1 renewal
maxLength: 255
nullable: false
size:
description: >-
ファイルサイズ
(バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。
type: integer
example: 629644
nullable: false
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'
nullable: false
modified_at:
description: Boxでこのファイルが最後に更新された日時。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: false
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
content_created_at:
description: このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
nullable: true
content_modified_at:
description: このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。
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: このファイルを最後に変更したユーザー。
- nullable: false
owned_by:
allOf:
- $ref: '#/components/schemas/User--Mini'
- description: このファイルを所有するユーザー。
- nullable: false
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
parent:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: >-
このフォルダが配置されているフォルダ。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる可能性があります。
nullable: true
item_status:
description: |-
この項目が削除されたかどうかを定義します。
- `active` - 項目がごみ箱に移動されていない場合。
- `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。
- `deleted` - 項目がすでに完全に削除されている場合。
type: string
example: active
enum:
- active
- trashed
- deleted
nullable: false
title: File
x-box-resource-id: file
x-box-tag: files
x-box-variant: standard
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
ResourceScope:
description: リソース (ファイルまたはフォルダ) とそのリソースにアクセスできるスコープの関係。
type: object
properties:
scope:
description: リソースへのアクセスのスコープ。
type: string
example: item_download
enum:
- annotation_edit
- annotation_view_all
- annotation_view_self
- base_explorer
- base_picker
- base_preview
- base_upload
- item_delete
- item_download
- item_preview
- item_rename
- item_share
- item_upload
- item_read
object:
$ref: '#/components/schemas/Resource'
title: リソースのスコープ
Metadata--Full:
description: ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。
type: object
allOf:
- $ref: '#/components/schemas/Metadata'
- properties:
$canEdit:
description: このメタデータインスタンスをユーザーが編集できるかどうか。
type: boolean
example: true
$id:
description: メタデータインスタンスを識別するためのUUID。
type: string
format: uuid
example: 01234500-12f1-1234-aa12-b1d234cb567e
maxLength: 36
$type:
description: >-
このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。
type: string
example: properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0
$typeVersion:
description: >-
オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。
type: integer
example: 2
- additionalProperties:
allOf:
- {}
- example: Aaron Levie
- description: >-
メタデータテンプレートに存在する各フィールドの値。`global.properties`テンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。
x-box-example-key: name
title: メタデータインスタンス (Full)
x-box-resource-id: metadata--full
x-box-tag: file_metadata
x-box-variant: full
File--Mini:
description: 他のリソースの下にネストされたときに使用されるファイルのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/File--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: Contract.pdf
sha1:
description: ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。
type: string
format: digest
example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37
nullable: false
file_version:
allOf:
- $ref: '#/components/schemas/FileVersion--Mini'
- description: ファイルの現在のバージョンに関する情報。
nullable: true
title: ファイル (Mini)
x-box-resource-id: file--mini
x-box-tag: files
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--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
Resource:
description: ファイルまたはフォルダのリソース。
type: object
oneOf:
- $ref: '#/components/schemas/Folder--Mini'
- $ref: '#/components/schemas/File--Mini'
title: リソース
Metadata:
description: ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。
type: object
allOf:
- $ref: '#/components/schemas/Metadata--Base'
title: メタデータインスタンス
x-box-resource-id: metadata
x-box-tag: file_metadata
x-box-variant: standard
File--Base:
description: 最も基本的なファイルのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。
type: object
properties:
id:
description: >-
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_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: 値は常に`file`になります。
type: string
example: file
enum:
- file
nullable: false
nullable: true
required:
- id
- type
title: ファイル (Base)
x-box-resource-id: file--base
x-box-tag: files
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
FileVersion--Mini:
description: 他のリソース内にネストされたときに使用されるファイルバージョンのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/FileVersion--Base'
- properties:
sha1:
description: ファイルの現在のバージョンのSHA1ハッシュ。
type: string
example: 134b65991ed521fcfe4724b7d814ab8ded5185dc
title: ファイルバージョン (Mini)
x-box-resource-id: file_version--mini
x-box-variant: mini
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
Metadata--Base:
description: メタデータインスタンスのBase版の表示。
type: object
properties:
$parent:
description: >-
このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。
type: string
example: folder_59449484661,
$template:
description: テンプレートの名前。
type: string
example: marketingCollateral
$scope:
description: >-
このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合は`enterprise_{enterprise_id}`、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合は`global`になります。
type: string
example: enterprise_27335
$version:
description: メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。
type: integer
example: 1
title: メタデータインスタンス (Base)
x-box-resource-id: metadata--base
x-box-tag: file_metadata
x-box-variant: base
x-box-variants:
- base
- standard
- full
FileVersion--Base:
description: 最も基本的なファイルバージョンのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。
type: object
properties:
id:
description: ファイルバージョンを表す一意の識別子。
type: string
example: '12345'
nullable: false
type:
description: 値は常に`file_version`になります。
type: string
example: file_version
enum:
- file_version
nullable: false
required:
- id
- type
title: ファイルバージョン (Base)
x-box-resource-id: file_version--base
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
securitySchemes:
OAuth2Security:
type: oauth2
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: リーガルホールドの管理
````