BObox
Uploads (Chunked)

List parts

Changed on

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

get/files/upload_sessions/{upload_session_id}/parts

Request

  • Base URL
    https://upload.box.com/api/2.0
  • URL
    https://upload.box.com/api/2.0/files/upload_sessions/{upload_session_id}/parts
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

upload_session_idstring required

The ID of the upload session.

Query parameters

offsetinteger

The offset of the item at which to begin the response.

Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

limitinteger

The maximum number of items to return per page.

Response

Returns a list of parts that have been uploaded.

Each part includes the hash type used to upload it. Parts uploaded with a SHA-512 Digest header don't include sha1.

total_countinteger

One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than total_count.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

offsetinteger

The 0-based offset of the first entry in this set. This will be the same as the offset query parameter.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

Example response

{
  "total_count": 5000,
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "entries": [
    {
      "part_id": "6F2D3486",
      "offset": 16777216,
      "size": 3222784,
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
      "sha512": "ae78a0ca28abffe70ac9aba830556cd6eb3fcf1501dbd9b2d7a5f45992c00812cb07b51bbd0a9174e2295671c0e86f30354afa91d281d4fbee6a323a483d6383"
    }
  ]
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status