Upload part
アップロードセッションチャンクのレプリゼンテーション。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
part_id | string | いいえ | チャンクの一意のID。 |
offset | integer | いいえ | ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。 |
size | integer | いいえ | チャンクのサイズ (バイト単位)。 |
sha1 | string | いいえ | チャンクのSHA1ハッシュ。 |
sha512 | string | いいえ | チャンクのSHA-512ハッシュ。128個の英小文字からなる16進文字列です。 |
例
{
"part_id": "6F2D3486",
"offset": 16777216,
"size": 3222784,
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383"
}
Upload part
アップロードセッションのアップロード済みチャンクのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
total_count | integer | いいえ | コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、total_countよりも少ない場合があります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
offset | integer | いいえ | このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、offsetクエリパラメータと同じになります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
order | array of object | いいえ | 項目が返される順序。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
entries | array of Upload part | いいえ | アップロードセッションのアップロード済みチャンクのリスト。 |
例
{
"total_count": 5000,
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"entries": [
{
"part_id": "6F2D3486",
"offset": 16777216,
"size": 3222784,
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383"
}
]
}
アップロードされたパーツ
いくつかのエンドポイントで返されるように、アップロードセッションの一部としてアップロードされたファイルのチャンク。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
part | Upload part | いいえ |
例
{
"part": {
"part_id": "6F2D3486",
"offset": 16777216,
"size": 3222784,
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383"
}
}
アップロードセッション
ファイルをアップロードするチャンクのアップロードセッション。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | いいえ | このセッションの一意の識別子。 |
type | enum<string> | いいえ | 値は常にupload_sessionになります。 使用可能なオプション: upload_session. |
session_expires_at | string | いいえ | このセッションが期限切れになる日時。 |
part_size | integer | いいえ | アップロードのすべての部分で使用する必要があるサイズ (バイト単位)。 最後の部分のみ、これより小さいサイズを使用できます。 |
total_parts | integer | いいえ | ファイルのサイズとパーツのサイズで決定される、このアップロードセッションで予想されるパーツの総数。 |
num_parts_processed | integer | いいえ | アップロードが完了し、サーバーで処理されたパーツの数。値は0から始まります。 ファイルをコミットするときにこのプロパティを調べることで、すべてのパーツが正しくアップロードされているかどうかを確認できます。 |
session_endpoints | object | いいえ | 分割アップロードセッションに使用されるエンドポイントのリスト。 |
例
{
"id": "F971964745A5CD0C001BBE4E58196BFD",
"type": "upload_session",
"session_expires_at": "2012-12-12T10:53:43-08:00",
"part_size": 1024,
"total_parts": 1000,
"num_parts_processed": 455,
"session_endpoints": {
"plan": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/plan",
"upload_part": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
"commit": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit",
"abort": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
"list_parts": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts",
"status": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
"log_event": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log"
}
}
アップロードセッション計画のリクエスト
アップロードセッションを計画するためのリクエスト本文。これにより、アップロード前に、サーバーにすでに存在するパーツを確認できます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
parts | array of アップロードパーツ計画 | はい | 存在するかどうかを確認するパーツのリスト。 |
例
{
"parts": [
{
"offset": 0,
"size": 8388608,
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383"
},
{
"offset": 8388608,
"size": 8388608,
"sha512": "588fde2156e1d8b23c9ca88ed3bed7bd1270e6ba0bb5b97b294ea1498952d7fd505e406097638514df92e9c5fecd0e73bd872499fcd7ea18eeb18567d0e09020"
}
]
}
アップロードセッション計画のレスポンス
アップロードセッションの計画結果を表すレスポンス。すでに存在するパーツ (ヒット) とアップロードする必要があるパーツ (ミス) に関する情報が含まれます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
upload_session_id | string | はい | このアップロードセッションの一意の識別子。 |
hits | array of アップロードパーツ計画のヒット | はい | サーバー上にすでに存在し、再度アップロードする必要のないパーツ。 |
misses | array of アップロードパーツ計画 | はい | サーバー上に存在せず、アップロードする必要があるパーツ。 |
例
{
"upload_session_id": "F971964745A5CD0C001BBE4E58196BFD",
"hits": [
{
"offset": 0,
"size": 8388608,
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383",
"part_id": "BFDF5379"
}
],
"misses": [
{
"offset": 8388608,
"size": 8388608,
"sha512": "588fde2156e1d8b23c9ca88ed3bed7bd1270e6ba0bb5b97b294ea1498952d7fd505e406097638514df92e9c5fecd0e73bd872499fcd7ea18eeb18567d0e09020"
}
]
}
アップロードパーツ計画
アップロードセッションの計画に使用する、SHA-512ハッシュを含むアップロード予定のパーツを表します。
属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
offset | integer | はい | ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。 |
size | integer | はい | チャンクのサイズ (バイト単位)。 |
sha512 | string | はい | チャンクのSHA-512ハッシュ。128個の英小文字からなる16進文字列です。 |
例
{
"offset": 0,
"size": 8388608,
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383"
}
アップロードパーツ計画のヒット
サーバー上にすでに存在することが確認されたアップロードパーツ (キャッシュヒット) を表します。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
offset | integer | はい | ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。 |
size | integer | はい | チャンクのサイズ (バイト単位)。 |
sha512 | string | はい | チャンクのSHA-512ハッシュ。128個の英小文字からなる16進文字列です。 |
part_id | string | はい | チャンクの一意のID。 |
例
{
"offset": 0,
"size": 8388608,
"sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383",
"part_id": "BFDF5379"
}
パーツのアップロード (Mini)
アップロードセッションチャンクのBase版の表示。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
part_id | string | いいえ | チャンクの一意のID。 |
offset | integer | いいえ | ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。 |
size | integer | いいえ | チャンクのサイズ (バイト単位)。 |
例
{
"part_id": "6F2D3486",
"offset": 16777216,
"size": 3222784
}