ファイルをアップロード

post
https://upload.box.com/api/2.0
/files/content

小さいファイルをBoxにアップロードします。ファイルサイズが50MBを超える場合は、分割アップロードAPIを使用することをお勧めします。

リクエスト本文の順序

本文のattributes部分はfile部分のに置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP 400エラーとmetadata_after_file_contentsエラーコードが返されます。

リクエスト

multipart/form-data

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

リクエスト本文

object本文内

アップロードされるファイルの追加の属性。主に名前と親フォルダ。これらの属性はマルチパートリクエスト本文に含まれており、JSON形式です。

本文のattributes部分はfile部分のに置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP 400エラーとmetadata_after_file_contentsエラーコードが返されます。

string / date-timenull省略可能
2012-12-12T10:53:43-08:00

ファイルが最初に作成された日時を定義します。

設定されていない場合は、アップロード日時が使用されます。

string / date-timenull省略可能
2012-12-12T10:53:43-08:00

ファイルが最後に変更された日時を示します。

設定されていない場合は、アップロード日時が使用されます。

stringnull省略可能
Photo.png

ファイルの名前

ファイルのアップロード先の親フォルダ

stringnull省略可能
124132

親フォルダのID。ユーザーのルートフォルダを指定するには、0を使用します。

string / binary本文内必須

Boxにアップロードするファイルのコンテンツ。

本文のattributes部分はfile部分のに置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP 400エラーとmetadata_after_file_contentsエラーコードが返されます。

リクエストヘッダー

stringヘッダー内
省略可能
134b65991ed521fcfe4724b7d814ab8ded5185dc

ファイルが転送中に破損していないことを確認するための、ファイルのSHA1ハッシュを含むヘッダー(省略可)。

レスポンス

application/jsonFiles

リスト内の新しいファイルオブジェクトを返します。

ファイルがすでに存在する場合、またはアカウントのディスク容量が不足している場合は、エラーを返します。

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

post
ファイルをアップロード
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -X POST https://upload.box.com/api/2.0/files/content \
     -H 'Authorization: Bearer <ACCESS_TOKEN>" '
     -H "Content-Type: multipart/form-data" \
     -F attributes='{"name":"Photo.jpg", "parent":{"id":"11446498"}}' \
     -F file=@<FILE_NAME>
.NET
using (FileStream fileStream = new FileStream(filePath, FileMode.Open))
{
    BoxFileRequest requestParams = new BoxFileRequest()
    {
        Name = uploadFileName,
        Parent = new BoxRequestEntity() { Id = "0" }
    };

    BoxFile file = await client.FilesManager.UploadAsync(requestParams, fileStream);
}
Java
BoxFolder rootFolder = BoxFolder.getRootFolder(api);
FileInputStream stream = new FileInputStream("My File.txt");
BoxFile.Info newFileInfo = rootFolder.uploadFile(stream, "My File.txt");
stream.close();
Python
folder_id = '22222'
new_file = client.folder(folder_id).upload('/home/me/document.pdf')
print('File "{0}" uploaded to Box with file ID {1}'.format(new_file.name, new_file.id))
Node
var fs = require('fs');
var stream = fs.createReadStream('/path/to/My File.pdf');
var folderID = '0'
client.files.uploadFile(folderID, 'My File.pdf', stream)
	.then(file => {
		/* file -> {
			total_count: 1,
			entries: 
			[ { type: 'file',
				id: '11111',
				file_version: 
					{ type: 'file_version',
					id: '22222',
					sha1: '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33' },
				sequence_id: '0',
				etag: '0',
				sha1: '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33',
				name: 'My File.pdf',
				description: '',
				size: 68431,
				path_collection: 
					{ total_count: 1,
					entries: 
					[ { type: 'folder',
						id: '0',
						sequence_id: null,
						etag: null,
						name: 'All Files' } ] },
				created_at: '2017-05-16T15:18:02-07:00',
				modified_at: '2017-05-16T15:18:02-07:00',
				trashed_at: null,
				purged_at: null,
				content_created_at: '2017-05-16T15:18:02-07:00',
				content_modified_at: '2017-05-16T15:18:02-07:00',
				created_by: 
					{ type: 'user',
					id: '33333',
					name: 'Test User',
					login: 'test@example.com' },
				modified_by: 
					{ type: 'user',
					id: '33333',
					name: 'Test User',
					login: 'test@example.com' },
				owned_by: 
					{ type: 'user',
					id: '33333',
					name: 'Test User',
					login: 'test@example.com' },
				shared_link: null,
				parent: 
					{ type: 'folder',
					id: '0',
					sequence_id: null,
					etag: null,
					name: 'All Files' }
				item_status: 'active' } ] }
		*/
	});
iOS
let data = "test content".data(using: .utf8)

let task: BoxUploadTask = client.files.upload(data: data, name: "Test File.txt", parentId: "0") { (result: Result<File, BoxSDKError>) in
    guard case let .success(file) = result else {
        print("Error uploading file")
        return
    }

    print("File \(file.name) was uploaded at \(file.createdAt) into \"\(file.parent.name)\"")
}

// To cancel upload
if someConditionIsSatisfied {
    task.cancel()
}