Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最新バージョン
アップロードセッションを作成
APIバージョン 2024.0
新しいファイルのアップロードセッションを作成します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
リクエスト本文
string本文内必須
"Project.mov"新規ファイルの名前。
integer (int64)本文内必須
104857600アップロードされるファイルの合計バイト数。
string本文内必須
"0"新しいファイルのアップロード先フォルダのID。
レスポンス
application/jsonアップロードセッション
新しいアップロードセッションを返します。
application/jsonクライアントエラー
パラメータが不足しているか無効の場合はエラーを返します。
missing_destination:folder_idが指定されていません。invalid_folder_id:folder_idが無効です。item_name_invalid:file_nameが無効です。missing_file_size:file_sizeが指定されていません。invalid_file_size:file_sizeが有効な数値ではありません。file_size_too_small:file_sizeが、このAPIによるアップロードの最小ファイルサイズを下回っています。missing_file_name:file_nameが指定されていません。
application/jsonクライアントエラー
何らかの理由で操作が許可されていない場合にエラーを返します。
storage_limit_exceeded: アカウントのストレージサイズの上限に達しました。
application/jsonクライアントエラー
親フォルダが見つからないか、認証済みユーザーが親フォルダにアクセスできない場合はエラーを返します。
invalid_parameter:folder_id値は、ユーザーがアクセスできないフォ ルダまたは存在しないフォルダを表します。
application/jsonクライアントエラー
ファイルがすでに存在する場合、またはアカウントのディスク容量が不足している場合は、エラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X POST "https://upload.box.com/api/2.0/files/upload_sessions" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"folder_id": "0",
"file_size": 104857600,
"file_name": "Contract.pdf"
}'Node/TypeScript v10
await client.chunkedUploads.createFileUploadSession({
fileName: fileName,
fileSize: fileSize,
folderId: parentFolderId,
} satisfies CreateFileUploadSessionRequestBody);Python v10
client.chunked_uploads.create_file_upload_session(
parent_folder_id, file_size, file_name
).NET v10
await client.ChunkedUploads.CreateFileUploadSessionAsync(requestBody: new CreateFileUploadSessionRequestBody(fileName: fileName, fileSize: fileSize, folderId: parentFolderId));Swift v10
try await client.chunkedUploads.createFileUploadSession(requestBody: CreateFileUploadSessionRequestBody(fileName: fileName, fileSize: Int64(fileSize), folderId: parentFolderId))Java v10
client.getChunkedUploads().createFileUploadSession(new CreateFileUploadSessionRequestBody(parentFolderId, fileSize, fileName)).NET v6
await client.ChunkedUploads.CreateFileUploadSessionAsync(requestBody: new CreateFileUploadSessionRequestBody(fileName: fileName, fileSize: fileSize, folderId: parentFolderId));Node v4
await client.chunkedUploads.createFileUploadSession({
fileName: fileName,
fileSize: fileSize,
folderId: parentFolderId,
} satisfies CreateFileUploadSessionRequestBody);レスポンスの例
{
"id": "F971964745A5CD0C001BBE4E58196BFD",
"type": "upload_session",
"num_parts_processed": 455,
"part_size": 1024,
"session_endpoints": {
"abort": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
"commit": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit",
"list_parts": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts",
"log_event": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log",
"status": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
"upload_part": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
},
"session_expires_at": "2012-12-12T10:53:43-08:00",
"total_parts": 1000
}