Skip to main content

dataRoomDocumentUpload

Retrieves the status and details of a document upload request by its unique ID. This is used to track progress through the upload pipeline — from initiation to processing completion.

Clients should use this query to poll the upload status after initiating an upload (either single-part or multipart).

The response includes the current DocumentTransferStatus, associated timestamps, and a reference to the resulting document (if available).

dataRoomDocumentUpload(
  id: ID!
): DataRoomDocumentUpload

Arguments​

dataRoomDocumentUpload.id ● ID! non-null scalar​

The unique identifier of the upload session.

Type​

DataRoomDocumentUpload object​

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.