Skip to main content

DataRoomDocument

Represents a document within the Data Room’s folder structure. This type implements the IDataRoomDocumentIndexItem interface and is a leaf node in the document index hierarchy. Documents are subject to security policies and visibility settings that determine how they can be accessed or downloaded by users, especially external participants.

type DataRoomDocument implements IDataRoomDocumentIndexItem {
  id: ID!
  status: DataRoomDocumentIndexStatus!
  name: String!
  number: String
  createdDate: DateTime
  lastModifiedDate: DateTime
  parentId: ID
  file: File!
  securityPolicy: DataRoomDocumentSecurity!
}

Fields​

DataRoomDocument.id ● ID! non-null scalar​

The unique identifier for the document.

DataRoomDocument.status ● DataRoomDocumentIndexStatus! non-null enum​

The current status of the document (Enabled or Disabled).

DataRoomDocument.name ● String! non-null scalar​

The display name of the document.

DataRoomDocument.number ● String scalar​

An optional index or reference number for ordering or display (e.g., "1.2.1").

DataRoomDocument.createdDate ● DateTime scalar​

Date when document was first added to the DataRoom. Returned in UTC time zone.

Only available for roles with access to Manage Documents, such as Administrator, Publisher and Viewer. For other roles, such as Guest and Limited Viewer this field will always be null.

DataRoomDocument.lastModifiedDate ● DateTime scalar​

Date when document was last modified. Modification can include changes to any of the document fields, such as content, name, number, enabled status or whenever a new file is uploaded. Returned in UTC time zone.

Guaranteed to be present for roles with access to Manage Documents, such as Administrator, Publisher and Viewer. For other roles, such as Guest and Limited Viewer this field will return either of: * Date the document was last enabled * Date of last file upload * null What data would be returned depends on the settings configured by Administrator for the DataRoom.

DataRoomDocument.parentId ● ID scalar​

ID of the parent folder that contains this document. null if it's a root-level document.

DataRoomDocument.file ● File! non-null object​

The file currently associated with this document, containing details like extension and size. When a user uploads a new version of the document's content, this points to a different, new DataRoomFile - the previous File is not mutated.

DataRoomDocument.securityPolicy ● DataRoomDocumentSecurity! non-null object​

Defines the document's access control and security settings, such as watermarking, view-only restrictions, or print/download permissions.

Interfaces​

IDataRoomDocumentIndexItem interface​

Defines the contract for items in the DataRoom document index. Base interface for both documents and folders in the indexing system.

Returned By​

dataRoomDocument query

Member Of​

AiReviewDocument object ● DataRoomDocumentDownload object ● DataRoomDocumentUpload object