The folder, with the fields that only a room carries filled in when the folder is a room.
| Name | Type | Description | Notes |
|---|---|---|---|
| title | str | 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] |
| shared_by | 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] |
| owned_by | 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 | bool | 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] |
| shared_for_user | bool | 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] |
| shared_external | bool | 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] |
| parent_shared | bool | 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] |
| short_web_url | str | 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] |
| created_by | 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] |
| auto_delete | 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] |
| root_folder_type | 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] |
| parent_room_type | 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] |
| updated_by | EmployeeDto | Who changed the entry last. It is null for a caller without an account. | [optional] |
| provider_item | bool | 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] |
| provider_key | str | 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] |
| provider_id | int | 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 | str | 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] |
| is_favorite | bool | 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] |
| file_entry_type | 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] |
| id | int | 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] |
| root_folder_id | int | 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] |
| origin_id | int | 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] |
| origin_room_id | int | The room the entry was deleted from, left out of the answer for anything that was not deleted out of a room. | [optional] |
| origin_title | str | 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] |
| origin_room_title | str | The name of the room the entry was deleted from, null for anything that was not deleted out of a room. | [optional] |
| can_share | bool | 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] |
| share_settings | AiFileEntryDtoAllOfShareSettings | [optional] | |
| security | AiFileEntryDtoAllOfSecurity | [optional] | |
| available_share_rights | AiFileEntryDtoAllOfAvailableShareRights | [optional] | |
| request_token | str | 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 | bool | 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] |
| expiration_date | 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] |
| is_link_expired | bool | 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] |
| assigned_metadata_templates | List[int] | The IDs of the metadata templates assigned to the file entry. | [optional] |
| metadata_matches | List[MetadataMatchDto] | Where the search text of the listing was met in the metadata of the entry: one item per string value holding the text, in the order of the fields. Present only in a listing filtered by text, and only for the entries whose metadata contain it; an entry found by its title alone carries nothing here. | [optional] |
| parent_id | int | The folder this one is listed in. For a room it is the root of the section the room lives in, and for an entry opened through a sharing link whose real parent the caller may not read it is the root of the section with the entries shared with them. | [optional] |
| files_count | int | How many files lie directly in the folder, without counting the subfolders. The roots of the Rooms, room templates, default templates and AI agents sections always report 0, because the number is not collected for them. |
[optional] |
| folders_count | int | How many subfolders lie directly in the folder. For an AI room the two service subfolders it always holds are subtracted, so the number matches what a listing of it shows, and the roots of the Rooms, templates and AI agents sections report 0. |
[optional] |
| is_shareable | bool | Whether the caller may hand out access to the folder. It is filled in only for the folder a folder-contents answer is about, and is null in every other answer, so null says nothing about the sharing rights. | [optional] |
| new | int | How many entries inside the folder the caller has not opened yet, the number drawn as the badge on it. An account that turned the badges off in its own settings always reads 0 here, so 0 alone does not prove that everything has been seen. | [optional] |
| mute | bool | Whether the caller silenced the notifications of this room: true means no message about its activity reaches them. The choice belongs to the reading account rather than to the room, so two members of one room read different values. | [optional] |
| tags | List[str] | The names of the tags attached to the room. Empty for a folder that is not a room, since only rooms carry tags, and the names are the ones from the portal tag catalogue. | [optional] |
| logo | LogoDto | The addresses of the room logo in four sizes, together with the colour and the built-in cover that are drawn when no logo was uploaded. A room without a logo answers with four empty addresses rather than with null, and the field is null for a folder that is not a room. | [optional] |
| pinned | bool | Whether the caller pinned the room to the top of their own room list. Pinning is personal and is lost when the room is archived. | [optional] |
| room_type | RoomType | The kind of the room, which decides the default access rules of its members. Null for a folder that is not a room. | [optional] |
| private | bool | Whether the room is a private one, which limits it to the accounts invited into it and needs encryption keys set up for each of them. | [optional] |
| indexing | bool | Whether the contents of the room are kept in an explicit numbered order, the one reported as order on each entry, instead of being left to the sorting the reader asks for. |
[optional] |
| deny_download | bool | Whether downloading and printing the contents of the room is forbidden, which leaves its members with viewing and editing in the editor. | [optional] |
| lifetime | RoomDataLifetimeDto | The rule by which the files of the room are removed once they grow old. Null when the room has no such rule, which is also what is reported after the rule is switched off, because switching it off erases it. | [optional] |
| watermark | WatermarkDto | The watermark stamped over the documents of the room while they are viewed and printed. Null when the room has no watermark, and for every folder that is not a room. | [optional] |
| type | FolderType | The part the folder plays inside its room: one of the service folders of the form-filling flow, or the knowledge and result storages of an AI room. It stays null for an ordinary folder and for the room itself, so it does not describe folders in general. | [optional] |
| in_room | bool | Whether the caller holds the room through an invitation of their own: true for the account that created it and for a member invited personally, false when the access comes from a group they belong to, and null for a folder that is not a room. | [optional] |
| quota_limit | int | How much space the files of the room may take, in bytes. It is the limit set on this room, or the portal default for rooms when none was set. Null when the tariff of the portal does not count room statistics, when room quotas are switched off, when the room lies in the archive or the trash, or when the role of the caller in the room carries no editing rights - a viewer, a commenter, a reviewer and a form filler do not see the figure, a room manager, a content creator and an editor do. | [optional] |
| is_custom_quota | bool | Whether quotaLimit is a limit set on this room (true) or the portal default for rooms (false). Null exactly when quotaLimit is null. |
[optional] |
| used_space | int | How much the files of the room take, in bytes, as of the last time the counter was recomputed. The counter is refreshed when a file operation finishes, so a read right after an upload or a deletion can still report the previous figure. Null for a folder that is not a room. | [optional] |
| password_protected | bool | Whether the sharing link the folder was opened through asks for a password that has not been entered yet. While it is true the contents stay unreadable; send the password to POST api/2.0/files/share/{key}/password first. Null when the folder was not reached through a link. |
[optional] |
| expired | bool | Deprecated, read isLinkExpired instead: whether the sharing link the folder was opened through has run out of its lifetime. |
[optional] |
| chat_settings | ChatSettingsDto | The chat configuration of an AI room. Only the system prompt is reported here, whatever else the room stores, and the field is null for every folder that is not an AI room. | [optional] |
| root_room_type | RoomType | The kind of the room the folder lies in. It is filled in only for the folder a folder-contents answer is about, and only when that room is an AI room, so it is null in every other answer and for every other room kind. | [optional] |
| save_form_as_xlsx | bool | Whether the answers collected in this form-filling room are also gathered into a spreadsheet next to the completed copies. Filled in for form-filling rooms only. | [optional] |
| send_form_to_external_db | bool | Whether the answers collected in this form-filling room are also pushed into the external database configured for the portal. Filled in for form-filling rooms only. | [optional] |
| original_form_id | int | The form the completed copies in this folder were filled from, taken from the copy submitted last. Null while the folder holds no completed copy, and for every folder that does not collect them. | [optional] |
from docspace_api_sdk.models.folder_dto import FolderDto
# TODO update the JSON string below
json = "{}"
# create an instance of FolderDto from a JSON string
folder_dto_instance = FolderDto.from_json(json)
# print the JSON string representation of the object
print(FolderDto.to_json())
# convert the object into a dict
folder_dto_dict = folder_dto_instance.to_dict()
# create an instance of FolderDto from a dict
folder_dto_from_dict = FolderDto.from_dict(folder_dto_dict)