ThirdPartyFileDto

A stored file as the calling account sees it: where it lives, which revision this is, how it can be opened and what the portal is currently doing with it.

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	FileShare	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	EmployeeDto	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	EmployeeDto	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	ApiDateTime	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	EmployeeDto	Who created the entry. It is null for a caller without an account, who is told nothing about the portal's members.	[optional]
updated	ApiDateTime	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	ApiDateTime	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	FolderType	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	FolderType	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	EmployeeDto	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	FileEntryType	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	String	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	String	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	String	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	String	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]
originRoomTitle	String	The name of the room the entry was deleted from, null for anything that was not deleted out of a room.	[optional]
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]
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]
expirationDate	ApiDateTime	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]
assignedMetadataTemplates	List (int32)	The IDs of the metadata templates assigned to the file entry.	[optional]
folderId	String	The folder the file is stored in. When the file was reached through a share and the caller cannot open its real parent, the identifier of the Shared with me section is reported instead, so this is where the file is visible rather than where it physically sits.	[optional] [nullable]
version	Integer (int32)	The revision this entry describes. It starts at 1 and moves to the next number each time new content is stored over the file, except for an editing session opened against the file itself, which replaces the content and keeps the number. GET api/2.0/files/file/{fileId}/history lists them all.	[optional]
versionGroup	Integer (int32)	Groups revisions that belong together, which is how a history can fold a long editing session into one entry: versions saved inside one session share this number, and an upload over the file starts a new group.	[optional]
contentLength	String	The size already formatted for display, with a unit and the separators of the caller's language. Read pureContentLength for a number to calculate with.	[optional] [nullable]
pureContentLength	Long (int64)	The size of the stored content in bytes, and null for an empty file.	[optional] [nullable]
fileStatus	FileStatus	What the portal is currently doing with the file and how the caller stands towards it - open in the editor, unread, being converted, and so on. The value is a bit mask that combines those states, so a file can report a number that matches none of the published members on its own.	[optional] [enum: 0, 1, 2, 4, 8, 16, 32, 64, 128, 256]
editingBy	Map	The accounts that have the file open in the editor at this moment, as account identifier to display name, and empty when nobody has. The all-zero identifier stands for people who came in through an external link without signing in, and its name carries their number in brackets when there is more than one.	[optional]
mute	Boolean	Not a property of the file at all: it repeats, inverted, the calling account's own switch for new-item badges, so it is the same in every entry of one answer. True means that account has badges turned off.	[optional]
viewUrl	URI (uri)	The address that returns the bytes of the file - a download, in spite of the name; webUrl is the address a person opens. When the file was reached through an external link the address carries the key of that link, so it keeps working without signing in.	[optional] [nullable]
webUrl	URI (uri)	The page that opens the file in a browser: the editor for a format the portal edits, the media viewer for pictures, audio and video, and the download address for a format it cannot show at all.	[optional] [nullable]
fileType	FileType	The broad kind of content, worked out from the extension, which is what a client uses to pick an icon or a viewer without parsing fileExst itself.	[optional] [enum: 0, 1, 2, 3, 4, 5, 6, 7, 10, 11]
fileExst	String	The extension of the stored file, leading dot included and always lower case. For a format the portal keeps in a converted shape this is the extension it is served under, not the one it was uploaded with.	[optional] [nullable]
comment	String	The note kept with this revision. The portal writes it itself for revisions it creates, an upload over an existing file among them, and an editor stores the note a person typed when saving a version.	[optional] [nullable]
encrypted	Boolean	True for a file in a private room, whose content the server never sees and which therefore cannot be converted or taken over by an upload. Null, rather than false, for an ordinary file.	[optional] [nullable]
thumbnailUrl	URI (uri)	The address of the generated preview image. It is filled in only while thumbnailStatus says the preview has been created, and it carries a suffix that changes with the file, so an image cached for an earlier revision is not reused.	[optional] [nullable]
thumbnailStatus	Thumbnail	How far the preview image has got. Only the created state means thumbnailUrl holds an address; the others mean there is none, either because it is still being produced or because this format has no preview.	[optional] [enum: 0, 1, 2, 3, 4]
locked	Boolean	True while the file is held under a lock that stops anyone but its holder from editing it, and null rather than false when there is no lock. lockedBy names the holder unless the caller is the holder.	[optional] [nullable]
lockedBy	String	The display name of the account holding the lock, and null when the caller holds it - so locked true together with no name here means the lock is the caller's own.	[optional] [nullable]
hasDraft	Boolean	For a fillable PDF form, whether the caller already has a filling draft of it, in which case draftLocation says where that draft lives. Null for anything that is not a form.	[optional] [nullable]
formFillingStatus	FormFillingStatus	How far the filling of this form has got for the calling account, and whose turn it is now. It is worked out only inside a virtual data room, where filling runs in steps; everywhere else it stays at the none value.	[optional] [enum: 0, 1, 2, 3, 4, 5]
isForm	Boolean	Whether the file is a PDF, and so offered as a fillable form. It is null for any other file type.	[optional] [nullable]
customFilterEnabled	Boolean	True while a spreadsheet is in the mode where each person sorts and filters their own view without changing what the others see, and null rather than false when it is not.	[optional] [nullable]
customFilterEnabledBy	String	The display name of the account that turned that mode on, and null when the caller turned it on themselves.	[optional] [nullable]
startFilling	Boolean	For a form in a room for filling, whether it has been released for filling; until then it is still being prepared and only the people running the room work with it. Null for a file this does not apply to.	[optional] [nullable]
isFillingPreparing	Boolean	True during the short window in which a released form is still being written out by the editor. Neither filling nor editing is accepted while it lasts, so a client should wait and read the file again.	[optional] [nullable]
inProcessFolderId	Integer (int32)	Left empty by the portal: the folder holding the caller's draft is reported in draftLocation instead.	[optional] [nullable]
inProcessFolderTitle	String	Left empty by the portal, like the identifier beside it; the draft's folder is named in draftLocation.	[optional] [nullable]
resultsFolderId	Integer (int32)	The folder that collects the completed copies of this form. It is filled in only for the original form of a room for filling, and only for a caller allowed to work with that form; null everywhere else.	[optional] [nullable]
draftLocation	ThirdPartyDraftLocation	Where the caller's own filling draft of this form is kept. Null when there is no draft yet, which is the same thing hasDraft reports.	[optional]
viewAccessibility	FileDto_allOf_viewAccessibility		[optional] [nullable]
lastOpened	ApiDateTime	The moment the caller last opened the file. It is kept per account and is what orders the Recent section, so it is null for a file this account has never opened. Written with the offset of the portal's time zone.	[optional]
expired	ApiDateTime	The moment the file falls under the lifetime rule of the room holding it and is removed. It is counted from the first revision rather than the latest one, so editing a file does not postpone it, and it is null when the room sets no lifetime. Written with the offset of the portal's time zone.	[optional]
vectorizationStatus	VectorizationStatus	How far the indexing of the file's content for AI search has got. It is null for a file that has never been queued for indexing, which is every file while the feature is off for the portal.	[optional] [enum: 0, 1, 2]
externalDbTableName	String	The table collecting the submitted values of this form in the external database configured for its room. The field is left out of the answer entirely when the form has no such table.	[optional] [nullable]
dimensions	ImageSizeDto	The pixel size of the picture, measured by reading the stored file rather than taken from any stored metadata. Null for anything that is not a picture the portal can show, and also when the file could not be read.	[optional]