Skip to main content

DataRoomFolder

Represents a folder within the Data Room's document index. Folders are hierarchical containers that may hold documents or other nested folders. This type implements the IDataRoomDocumentIndexItem interface and is used to structure the navigable view of the Data Room.

type DataRoomFolder implements IDataRoomDocumentIndexItem {
  id: ID!
  status: DataRoomDocumentIndexStatus!
  name: String!
  number: String
  createdDate: DateTime
  lastModifiedDate: DateTime
  hasChildren: Boolean!
  parentId: ID
  ancestors: [DataRoomFolder!]
}

Fields​

DataRoomFolder.id ● ID! non-null scalar​

The unique identifier for the folder.

DataRoomFolder.status ● DataRoomDocumentIndexStatus! non-null enum​

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

DataRoomFolder.name ● String! non-null scalar​

The display name of the folder.

DataRoomFolder.number ● String scalar​

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

DataRoomFolder.createdDate ● DateTime scalar​

Date the 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.

DataRoomFolder.lastModifiedDate ● DateTime scalar​

Date when folder was last modified. Modification can include changes to any of the folder fields, such as name, number or enabled status. 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.

DataRoomFolder.hasChildren ● Boolean! non-null scalar​

Indicates whether the folder contains any child items (documents or folders).

DataRoomFolder.parentId ● ID scalar​

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

DataRoomFolder.ancestors ● [DataRoomFolder!] list object​

The folders above this one, ordered from the top of the hierarchy down: the first item is the root-most folder and the last item is this folder's direct parent. Does not include this folder. Empty when this folder is at the root. Only available when querying a single folder; selecting it on folders inside a list returns an error. Used to render and navigate breadcrumbs.

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​

dataRoomFolder query

Member Of​

DataRoomDocument object ● DataRoomFolder object