Returns the details (but not the content) about a chunked upload.

Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.

Request

HTTP request

GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

chunkedUploadIdstring

The id of the chunked upload.

Optional Query Parameters
includestring

(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is checksum, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.

Responses

CodeDescriptionReference
200

Successful response.

ChunkedUploads
400

Error encountered.

errorDetails

SDK Method

Envelopes::getChunkedUpload

Definitions

chunkedUploadPart

An object that contains information about the chunked upload part.

sequencestring

The order of the part in the chunked upload.

sizestring

The size of the part in bytes.

We recommend that a chunked upload part is no larger than a few MB in size.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

ChunkedUploads

The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.

checksumstring

A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.

chunkedUploadIdstring

The id of the chunked upload.

chunkedUploadParts[chunkedUploadPart]

A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.

chunkedUploadUristring

The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests.

committedstring

When true, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests.

expirationDateTimestring

The UTC time at which the chunked upload expires and is no longer addressable.

Note: The length of time before expiration is configurable, and begins when you initiate the chunked upload. You must fully upload and use a chunked upload within this time. The default value for this duration is 20 minutes.

maxChunkedUploadPartsstring

The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256.

maxTotalSizestring

The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB.

totalSizestring

The total size of the parts of the chunked upload.

Note: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.

Examples

Generic JSON Response

Response
{
  "chunkedUploadId": "sample string 1",
  "chunkedUploadUri": "sample string 2",
  "expirationDateTime": "sample string 3",
  "checksum": "sample string 4",
  "committed": "sample string 5",
  "chunkedUploadParts": [
    {
      "sequence": "sample string 1",
      "size": "sample string 2"
    }
  ],
  "totalSize": "sample string 6",
  "maxChunkedUploadParts": "sample string 7",
  "maxTotalSize": "sample string 8"
}
Generic XML Response

Response
<chunkedUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <checksum>sample string 4</checksum>
  <chunkedUploadId>sample string 1</chunkedUploadId>
  <chunkedUploadParts>
    <chunkedUploadPart>
      <sequence>sample string 1</sequence>
      <size>sample string 2</size>
    </chunkedUploadPart>
  </chunkedUploadParts>
  <chunkedUploadUri>sample string 2</chunkedUploadUri>
  <committed>sample string 5</committed>
  <expirationDateTime>sample string 3</expirationDateTime>
  <maxChunkedUploadParts>sample string 7</maxChunkedUploadParts>
  <maxTotalSize>sample string 8</maxTotalSize>
  <totalSize>sample string 6</totalSize>
</chunkedUploadResponse> 
}} />