DataRoomDocumentDownload
Represents a multi-step, asynchronous operation to prepare and deliver a downloadable version of a document from the Data Room. The download process may involve tasks such as permission validation, watermarking, encryption, and secure URL generation. As a result, the downloadable file is not immediately available upon request. Clients must monitor the status field to track the progress of the request, and the downloadPresignedUrl field will remain null until the document is fully prepared. If an error occurs, the failureReason will indicate the cause.
type DataRoomDocumentDownload {
document: DataRoomDocument
id: ID!
downloadPresignedUrl: String
status: DocumentTransferStatus!
createdAt: DateTime!
updatedAt: DateTime!
expiresAt: DateTime
failureReason: String
}
Fields
DataRoomDocumentDownload.document ● DataRoomDocument object
The document that is being prepared for download.
DataRoomDocumentDownload.id ● ID! non-null scalar
Unique identifier for the document download request.
DataRoomDocumentDownload.downloadPresignedUrl ● String scalar
A time-limited, secure URL to download the prepared document. This field is null while the document is still processing or if the operation fails.
DataRoomDocumentDownload.status ● DocumentTransferStatus! non-null enum
Current status of the document download process.
DataRoomDocumentDownload.createdAt ● DateTime! non-null scalar
Timestamp indicating when the download request was created.
DataRoomDocumentDownload.updatedAt ● DateTime! non-null scalar
Timestamp of the latest update to the download request (e.g., when status changes).
DataRoomDocumentDownload.expiresAt ● DateTime scalar
Optional timestamp after which the download URL will expire and no longer be usable.
DataRoomDocumentDownload.failureReason ● String scalar
Explanation of why the download failed, if applicable (e.g., missing file, insufficient permissions).
Returned By
dataRoomDocumentDownload query