事前チェック

事前チェックAPIを使用すると、アプリケーションでアップロードを開始する前にそのファイルがBoxに受け入れられるかどうかを確認できます。このAPIは、新しいファイルにも、既存ファイルの新しいバージョンのアップロードにも使用できます。

事前チェックでは、ファイルが実際にアップロードされるときと同じように、以下のすべてのチェックが実行されます。

フォルダにアップロードするアプリケーションおよびユーザーの権限
ファイル名の競合
ファイルサイズの上限や制限
フォルダおよびファイルの名前に関する制約事項
フォルダおよびアカウントのストレージ容量

新しいファイルのチェックを実行するには、実際のファイルをアップロードする場合と同じパラメータ (バイナリコンテンツを除く) を使用してOPTIONS /files/content APIを呼び出してください。

curl -i -X OPTIONS "https://api.box.com/2.0/files/content" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{"name":"Contract.pdf", "parent":{"id":"11446498"}}'

Node/TypeScript v10

await client.uploads.preflightFileUploadCheck({
  name: newFileName,
  size: 1024 * 1024,
  parent: { id: '0' } satisfies PreflightFileUploadCheckRequestBodyParentField,
} satisfies PreflightFileUploadCheckRequestBody);

Python v10

client.uploads.preflight_file_upload_check(
    name=new_file_name, size=1024 * 1024, parent=PreflightFileUploadCheckParent(id="0")
)

.NET v10

await client.Uploads.PreflightFileUploadCheckAsync(requestBody: new PreflightFileUploadCheckRequestBody() { Name = newFileName, Size = 1024 * 1024, Parent = new PreflightFileUploadCheckRequestBodyParentField() { Id = "0" } });

Java v10

client.getUploads().preflightFileUploadCheck(new PreflightFileUploadCheckRequestBody.Builder().name(newFileName).size(1024 * 1024).parent(new PreflightFileUploadCheckRequestBodyParentField.Builder().id("0").build()).build())

.NET v6

await client.Uploads.PreflightFileUploadCheckAsync(requestBody: new PreflightFileUploadCheckRequestBody() { Name = newFileName, Size = 1024 * 1024, Parent = new PreflightFileUploadCheckRequestBodyParentField() { Id = "0" } });

Node v4

await client.uploads.preflightFileUploadCheck({
  name: newFileName,
  size: 1024 * 1024,
  parent: { id: '0' } satisfies PreflightFileUploadCheckRequestBodyParentField,
} satisfies PreflightFileUploadCheckRequestBody);

新しいファイルバージョンのチェックを実行するには、実際のファイルをアップロードする場合と同じパラメータ (バイナリコンテンツを除く) を使用してOPTIONS /files/:id/content APIを呼び出してください。

cURL

curl -i -X OPTIONS "https://api.box.com/2.0/files/12345/content" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{"name":"Contract.pdf", "parent":{"id":"11446498"}}'

分割アップロードを実行する場合、アップロードセッションの作成でも事前チェックが実行されるため、事前チェックは必須ではありません。

APIコールで問題が検出されると、HTTP 409 Conflictステータスコードとともに可能性のある競合を説明するメッセージが返されます。問題が検出されなかった場合、HTTP 200 OKステータスコードが返され、アップロードを続行できます。

200 OKレスポンスは、アップロード呼び出しが実際に成功することを保証するものではありません。事前チェックによりアップロードの失敗が99%以上削減されることが実証されていますが、ファイルのアップロード時に同時実行の問題が発生する可能性は残っています。

非常にアクティブで、クォータ制限に近づいているフォルダ、一般的なファイル名、およびアカウントの場合、事前チェックで200 OKが返されたとしても、実際のアップロード中に競合が発生する可能性があります。

事前チェックでは多くの場合、競合が検出されるとAPIレスポンスで有益なデータが返されます。たとえば名前の競合が検出された場合、アプリケーションではエラーレスポンスで返されるSHA-1を使用して、アップロードしようとしているファイルと既存ファイルが同一であるかどうかを確認できます。

事前チェック

事前チェック

チェックリスト

新しいファイルのチェック

新しいファイルバージョンのチェック

チェックと分割アップロード

レスポンスコード

レスポンスの本文

関連するAPI

関連するガイド