DataRoomDocumentUpload

Represents a multi-step, asynchronous process for uploading a document into the Data Room. After a file is uploaded (e.g., via multi-part upload or single upload), it goes through several processing stages such as virus scanning, metadata extraction, and indexing before it becomes fully available.

This object helps clients track the status of the upload. If the process is successful, the associated document will be available in the Data Room. If it fails, failureReason will explain why.

type DataRoomDocumentUpload {
  document: DataRoomDocument
  id: ID!
  status: DocumentTransferStatus!
  createdAt: DateTime!
  updatedAt: DateTime!
  expiresAt: DateTime
  failureReason: String
}

Fields

DataRoomDocumentUpload.document ● DataRoomDocument object

The document created from the uploaded file. May be null if the upload is still in progress or has failed.

DataRoomDocumentUpload.id ● ID! non-null scalar

The unique identifier for the document upload operation.

DataRoomDocumentUpload.status ● DocumentTransferStatus! non-null enum

The current status of the document upload.

DataRoomDocumentUpload.createdAt ● DateTime! non-null scalar

Timestamp when the upload process was initiated.

DataRoomDocumentUpload.updatedAt ● DateTime! non-null scalar

Timestamp of the latest update to the upload status.

DataRoomDocumentUpload.expiresAt ● DateTime scalar

Optional timestamp when the upload request or session expires.

DataRoomDocumentUpload.failureReason ● String scalar

If the upload fails, this field provides the error message or failure reason.

Returned By

dataRoomDocumentUpload query

Member Of

CompleteDataRoomDocumentMultiPartUploadPayload object ● InitiateDataRoomDocumentMultiPartUploadPayload object ● InitiateDataRoomDocumentUploadPayload object