AiFileEntryDto

The part of a file or folder that depends on how the entry is identified: by a number on the portal, or by a string on a connected third-party account.

Name	Type	Description	Notes
title	String	The name shown for the entry. For a file it carries the extension, which is how the format is recognised, and for a room it is the room name.	[optional]
access	AiFileShare	The level the calling account holds on this entry, resolved from its own rights, the groups it belongs to and any link it came in through. It is the level itself, not what the account may do with it - the action flags below answer that.	[optional] [enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
sharedBy	AiEmployeeDto	Who gave the calling account the access it is using. It is filled in only while the entry is being read through a share, and never for a caller without an account.	[optional]
ownedBy	AiEmployeeDto	Who owns the place the entry is shared from - the creator of the room it lies in, or of the personal section that holds it. It is filled in only while the entry is being read through a share, and never for a caller without an account.	[optional]
shared	Boolean	Whether at least one external link exists for the entry, whichever kind. It says nothing about accounts and groups - those are counted by the flag for members below.	[optional]
sharedForUser	Boolean	Whether at least one account or group has been given rights on the entry directly, as opposed to reaching it through a link or through the room around it.	[optional]
sharedExternal	Boolean	Whether one of the entry's links is open to people outside the portal, as opposed to a link that only its own members can follow. This is the flag to watch when the concern is who can reach the content from outside.	[optional]
parentShared	Boolean	Whether the entry is reachable because the room or folder around it is shared, rather than through rights of its own. A copy or a move takes the entry out of that scope.	[optional]
shortWebUrl	URI (uri)	A shortened address that opens the entry through the link it is being read with. It is an empty string whenever no link applies, which is the usual case for a member browsing their own rooms.	[optional]
created	AiApiDateTime	When the entry was created, written with the offset of the portal's time zone. For a file restored from an older version this is still the moment the file first appeared.	[optional]
createdBy	AiEmployeeDto	Who created the entry. It is null for a caller without an account, who is told nothing about the portal's members.	[optional]
updated	AiApiDateTime	When the entry last changed, written with the offset of the portal's time zone. It is never reported as earlier than the creation moment, so the two can be compared safely.	[optional]
autoDelete	AiApiDateTime	When the entry will disappear on its own, written with the offset of the portal's time zone. It is filled in only where a removal is actually scheduled - something in the trash while the portal cleans it up automatically, or a guest's own documents - so a null means nothing is scheduled rather than that the entry is permanent.	[optional]
rootFolderType	AiFolderType	The section the entry ultimately belongs to, which is what tells a personal document from one inside a room, from a template and from something in the trash or the archive.	[optional] [enum: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37]
parentRoomType	AiFolderType	The kind of room the entry lies in, which decides what the room allows - filling forms, public links, indexing. It is null for an entry that is not inside a room at all.	[optional] [enum: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37]
updatedBy	AiEmployeeDto	Who changed the entry last. It is null for a caller without an account.	[optional]
providerItem	Boolean	Set when the entry is stored on a connected third-party account rather than on the portal, and null when it is stored on the portal. Such an entry is identified by a string rather than a number, and some operations skip it.	[optional]
providerKey	String	Which third-party service holds the entry, matching the keys accepted by the third-party operations. It is null for an entry stored on the portal.	[optional]
providerId	Integer (int32)	The connected account the entry comes from, for telling apart two connections to the same service. It is null for an entry stored on the portal.	[optional]
order	String	The place of the entry in a room where the members arrange the content themselves, given as the position of the entry preceded by the positions of the folders leading to it, separated by dots. It is empty when nothing has been arranged.	[optional]
isFavorite	Boolean	Set when the calling account has marked the entry as a favorite, which is what puts it into the favorites listing. For a file that is not marked it is null rather than false.	[optional]
fileEntryType	AiFileEntryType	Tells a folder from a file, and so which of the two shapes the rest of the object has. A room is reported as a folder here.	[optional] [enum: 1, 2]
id	Integer (int32)	The identifier to pass back to the other operations of this entry. It is a number for storage on the portal and a string for a connected third-party account, and it is unique only within its own kind, so files and folders may carry the same value.	[optional]
rootFolderId	Integer (int32)	The section the entry ultimately lies in, as an identifier that can be listed like any other folder. For an entry inside a room this is the rooms section, not the room.	[optional]
originId	Integer (int32)	The folder the entry was deleted from, which is where restoring it puts it back. It is left out of the answer unless the entry is in the trash.	[optional]
originRoomId	Integer (int32)	The room the entry was deleted from, left out of the answer for anything that was not deleted out of a room.	[optional]
originTitle	String	The name of the folder the entry was deleted from, for showing where it would be restored to. It is null for an entry that is not in the trash.	[optional] [nullable]
originRoomTitle	String	The name of the room the entry was deleted from, null for anything that was not deleted out of a room.	[optional] [nullable]
canShare	Boolean	Whether the calling account may change who has access to the entry, and so whether offering a sharing dialog for it makes sense. It is false in rooms whose access is fixed by the room itself, such as a private one, even for its manager.	[optional]
shareSettings	AiFileEntryDto_allOf_shareSettings		[optional] [nullable]
security	AiFileEntryDto_allOf_security		[optional] [nullable]
availableShareRights	AiFileEntryDto_allOf_availableShareRights		[optional] [nullable]
requestToken	String	The token of the link the entry is being read through, which is the value the external-share operations expect and which also has to be carried by the download and preview addresses. It is null whenever the entry is not being read through a link.	[optional] [nullable]
external	Boolean	Set when the link being used was made for this very entry, and false when the entry is reached through a link to the room around it. It is null when no link is involved.	[optional] [nullable]
expirationDate	AiApiDateTime	When the link being used stops working, written with the offset of the portal's time zone. It is null for a link that never expires and whenever no link is involved.	[optional]
isLinkExpired	Boolean	Set when the link being used has already passed its expiration date, which is why the entry cannot be opened even though it is described here. It is null when no link is involved.	[optional] [nullable]
assignedMetadataTemplates	List (int32)	The IDs of the metadata templates assigned to the file entry.	[optional] [nullable]