Skip to main content

IDataRoomDocumentIndexItem

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

interface IDataRoomDocumentIndexItem {
  status: DataRoomDocumentIndexStatus!
  name: String!
  number: String
  parentId: ID
  createdDate: DateTime
  lastModifiedDate: DateTime
}

Fields​

IDataRoomDocumentIndexItem.status ● DataRoomDocumentIndexStatus! non-null enum​

The current status of the index item, indicating whether it is enabled or disabled.

IDataRoomDocumentIndexItem.name ● String! non-null scalar​

The display name of the item as shown in the DataRoom.

IDataRoomDocumentIndexItem.number ● String scalar​

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

IDataRoomDocumentIndexItem.parentId ● ID scalar​

The ID of the parent folder. null if this is a root-level folder.

IDataRoomDocumentIndexItem.createdDate ● DateTime scalar​

Date when document or folder 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.

IDataRoomDocumentIndexItem.lastModifiedDate ● DateTime scalar​

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

For folders: 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.

For documents: 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.

Member Of​

DataRoomDocumentIndexItemsConnection object ● DataRoomDocumentIndexItemsEdge object

Implemented By​

DataRoomDocument object ● DataRoomFolder object