Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

chunkedUploadId string
Optional query parameters
include string

A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::getChunkedUpload

Definitions Expand All | Collapse All

ChunkedUploads

Chunked Uploads resource

checksum string
chunkedUploadId string
chunkedUploadParts
[chunkedUploadPart]
chunkedUploadUri string
committed string
expirationDateTime string
maxChunkedUploadParts string
maxTotalSize string
totalSize string

chunkedUploadPart

sequence string
size string

Reserved: TBD

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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>