Skip to main content

InitiateDataRoomDocumentMultiPartUploadPayload

Returned when initiating a multipart upload for a document in the Data Room. This payload provides the necessary information to begin uploading file parts, including the upload session metadata and the total number of expected parts.

This is the first step in the multipart upload flow. It includes an upload object for tracking the overall upload status and a totalParts value used to divide the file for chunked uploads.

To upload the file parts, clients must call the generatePresignedUrlsForDataRoomDocumentMultiPartUpload mutation, passing the upload.id and desired part numbers. This returns secure URLs that can be used to upload each chunk directly to storage.

type InitiateDataRoomDocumentMultiPartUploadPayload {
  upload: DataRoomDocumentUpload
  totalParts: Int!
}

Fields​

InitiateDataRoomDocumentMultiPartUploadPayload.upload ● DataRoomDocumentUpload object​

The upload session object representing the initiated multipart upload. Use this to track upload progress and to complete the upload once all parts are submitted.

InitiateDataRoomDocumentMultiPartUploadPayload.totalParts ● Int! non-null scalar​

The total number of parts the file is divided into, based on the file size and chunk size. Clients must use this to manage part uploads correctly.

Returned By​

initiateDataRoomDocumentMultiPartUpload mutation