Request

HTTP request

POST /v2.1/accounts/{accountId}/chunked_uploads

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
201

Successful response.

ChunkedUploads
400

Error encountered.

errorDetails

SDK Method

Envelopes::createChunkedUpload

Definitions

chunkedUploadPart

sequencestring

sizestring

Reserved: TBD

chunkedUploadRequest

chunkedUploadIdstring

datastring

A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

ChunkedUploads

Chunked Uploads resource

checksumstring

chunkedUploadIdstring

chunkedUploadParts[chunkedUploadPart]

chunkedUploadUristring

committedstring

expirationDateTimestring

maxChunkedUploadPartsstring

maxTotalSizestring

totalSizestring

Examples

Generic JSON Request/Response

Request
{
  "chunkedUploadId": "sample string 1",
  "data": "sample string 2"
}
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 Request/Response

Request
<chunkedUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <chunkedUploadId>sample string 1</chunkedUploadId>
  <data>sample string 2</data>
</chunkedUploadRequest> 
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> 
}} />