Skip to main content

DataRoomBulkDownload

Bulk download details.

type DataRoomBulkDownload {
  id: ID!
  bulkDownloadName: String!
  status: DataRoomBulkDownloadStatus!
  progress: Int
  createdAt: DateTime!
  updatedAt: DateTime
  fileCount: Int
  totalSizeBytes: Long
  downloadUrl: URL
}

Fields​

DataRoomBulkDownload.id ● ID! non-null scalar​

Unique identifier for the bulk download job. Format: "dataRoomId:bulkDownloadJobId" (e.g. "123:456").

DataRoomBulkDownload.bulkDownloadName ● String! non-null scalar​

User-provided bulk download name.

DataRoomBulkDownload.status ● DataRoomBulkDownloadStatus! non-null enum​

Current lifecycle status of the bulk download job.

DataRoomBulkDownload.progress ● Int scalar​

Progress percentage for in-flight jobs (0-100).

DataRoomBulkDownload.createdAt ● DateTime! non-null scalar​

UTC timestamp when the request was created.

DataRoomBulkDownload.updatedAt ● DateTime scalar​

UTC timestamp of the most recent status update.

DataRoomBulkDownload.fileCount ● Int scalar​

Number of documents included in the job.

DataRoomBulkDownload.totalSizeBytes ● Long scalar​

Total size in bytes of source documents.

DataRoomBulkDownload.downloadUrl ● URL scalar​

URL to download the bulk download archive, populated only when status is DONE.

Returned By​

dataRoomBulkDownload query

Member Of​

InitiateDataRoomBulkDownloadPayload object