Skip to main content

dataRoomDocumentDownload

Retrieves the status and details of a document download request by its unique ID. This is used to track the progress of an asynchronous download operation.

Clients should use this query to poll the status of a download after initiating it via initiateDataRoomDocumentDownload. The response includes the current status , timestamps, and the secure downloadPresignedUrl once the document is ready.

dataRoomDocumentDownload(
  id: ID!
): DataRoomDocumentDownload

Arguments​

dataRoomDocumentDownload.id ● ID! non-null scalar​

The unique identifier of the download request.

Type​

DataRoomDocumentDownload object​

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.