Box Developerドキュメント
最新バージョン

アップロード前の事前チェック

options
https://api.box.com/2.0
/files/content

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ファイル全体をアップロードする前に、ファイルがBoxで受け入れられるかどうかをチェックします。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内省略可能
"File.mp4"

The name for the file.

object本文内

The parent folder to upload the file to.

string本文内省略可能
"123"

The ID of parent item.

integer (int32)本文内省略可能
1024

The size of the file in bytes.

レスポンス

application/jsonアップロードURL

チェックに合格した場合、レスポンスにはファイルのアップロード先として使用できるセッションURLが含まれます。

application/json競合エラー

チェックに合格しなかった場合、レスポンスにはその理由に関する詳細が含まれます。

予期しないクライアントエラー。

options
アップロード前の事前チェック
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
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"}}'
TypeScript Gen
await client.uploads.preflightFileUploadCheck({
  name: newFileName,
  size: 1024 * 1024,
  parent: { id: '0' } satisfies PreflightFileUploadCheckRequestBodyParentField,
} satisfies PreflightFileUploadCheckRequestBody);
Python Gen
client.uploads.preflight_file_upload_check(
    name=new_file_name, size=1024 * 1024, parent=PreflightFileUploadCheckParent(id="0")
)
.NET Gen
await client.Uploads.PreflightFileUploadCheckAsync(requestBody: new PreflightFileUploadCheckRequestBody() { Name = newFileName, Size = 1024 * 1024, Parent = new PreflightFileUploadCheckRequestBodyParentField() { Id = "0" } });
Java
String fileName = "My Doc.pdf";
BoxFolder rootFolder = BoxFolder.getRootFolder(api);
try {
    folder.canUpload(fileName, 98734576);

    // If the file upload would not have succeeded, it will not be attempted
    folder.uploadFile(fileContents, fileName);
} catch (BoxAPIException ex) (

)
Node
// Verify that uploading a 200MB file named "Preso.ppt" to folder 12345 would succeed
client.files.preflightUploadFile(
		'12345',
		{
			name: 'Preso.ppt',
			size: 200000000
		},
		null,
		callback
	);

レスポンスの例

{
  "upload_token": "Pc3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQP",
  "upload_url": "https://upload-las.app.box.com/api/2.0/files/content?upload_session_id=1234"
}