Skip to main content

dataRoomBulkDownload

Retrieves the status and details of a bulk download request by its unique ID. This is used to poll the progress of an asynchronous bulk download job.

Clients should use this query to poll the status after calling the initiateDataRoomBulkDownload mutation. The bulkDownloadId argument is the bulkDownload.id returned by that mutation.

The downloadUrl field will be populated once the status transitions to DONE.

bulkDownloadId format​

bulkDownloadId is a GraphQL global ID and must be **base64 encoded**.

If needed, clients can construct this ID manually. Raw (pre-encoded) format: DataRoomBulkDownload:<dataRoomId>:<bulkDownloadId>

Example raw value: DataRoomBulkDownload:79827:17650

Example​

query DataRoomBulkDownload {
dataRoomBulkDownload(
bulkDownloadId: "RGF0YVJvb21CdWxrRG93bmxvYWQ6Nzk4Mjc6MTc2NTA="
) {
id
bulkDownloadName
status
progress
createdAt
updatedAt
fileCount
totalSizeBytes
downloadUrl
}
}
dataRoomBulkDownload(
  bulkDownloadId: ID!
): DataRoomBulkDownload

Arguments​

dataRoomBulkDownload.bulkDownloadId ● ID! non-null scalar​

The unique identifier of the bulk download request.

Type​

DataRoomBulkDownload object​

Bulk download details.