アップロード (分割) リソース

分割アップロードエンドポイントは20 MB以上のファイルをサポートしており、アプリケーションでファイルを複数のパーツに分割してアップロードすることで、エラーのキャッチと個別のパーツの再送信を詳細に制御できます。

Upload part

アップロードセッションチャンクのレプリゼンテーション。

属性と例

プロパティ	型	必須	説明
`part_id`	`string`	いいえ	チャンクの一意のID。
`offset`	`integer`	いいえ	ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。
`size`	`integer`	いいえ	チャンクのサイズ (バイト単位)。
`sha1`	`string`	いいえ	チャンクのSHA1ハッシュ。

例

{
  "part_id": "6F2D3486",
  "offset": 16777216,
  "size": 3222784,
  "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}

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"
    }
  ]
}

アップロードされたパーツ

いくつかのエンドポイントで返されるように、アップロードセッションの一部としてアップロードされたファイルのチャンク。

属性と例

プロパティ	型	必須	説明
`part`	Upload part	いいえ

例

{
  "part": {
    "part_id": "6F2D3486",
    "offset": 16777216,
    "size": 3222784,
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  }
}

アップロードセッション

ファイルをアップロードするチャンクのアップロードセッション。

属性と例

プロパティ	型	必須	説明
`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": {
    "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"
  }
}

パーツのアップロード (Mini)

アップロードセッションチャンクのBase版の表示。

属性と例

プロパティ	型	必須	説明
`part_id`	`string`	いいえ	チャンクの一意のID。
`offset`	`integer`	いいえ	ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。
`size`	`integer`	いいえ	チャンクのサイズ (バイト単位)。

例

{
  "part_id": "6F2D3486",
  "offset": 16777216,
  "size": 3222784
}

​Upload part

​Upload part

​アップロードされたパーツ

​アップロードセッション

​パーツのアップロード (Mini)

Upload part

Upload part

アップロードされたパーツ

アップロードセッション

パーツのアップロード (Mini)