Dataroom ======== .. _Disclaimer: Disclaimer ---------- The Dataroom disclaimer, if any .. code-block:: json message Disclaimer { // ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/ google.protobuf.Timestamp creation_date = 1; optional google.protobuf.Timestamp acceptance_date = 2; string content = 3; } +---------------------+-------------------------------+-------------+ | Field | Type | Description | +=====================+===============================+=============+ | ``creation_date`` | ``google.protobuf.Timestamp`` | | +---------------------+-------------------------------+-------------+ | ``acceptance_date`` | ``google.protobuf.Timestamp`` | optional | +---------------------+-------------------------------+-------------+ | ``content`` | ``string`` | | +---------------------+-------------------------------+-------------+ .. _TemplateInfo: TemplateInfo ------------ Holds the settings for a specific data room instance. This is used in enterprise environments. .. code-block:: json message TemplateInfo { string template_id = 1; // ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/ google.protobuf.Timestamp modification_date = 2; optional DataroomSettings settings = 3; } +-----------------------+-------------------------------+-------------+ | Field | Type | Description | +=======================+===============================+=============+ | ``template_id`` | ``string`` | | +-----------------------+-------------------------------+-------------+ | ``modification_date`` | ``google.protobuf.Timestamp`` | | +-----------------------+-------------------------------+-------------+ | ``settings`` | ``DataroomSettings`` | optional | +-----------------------+-------------------------------+-------------+ .. _SendInfo: SendInfo -------- Holds the settings for a specific send instance .. code-block:: json message SendInfo { optional uint32 max_sent_actions = 1; optional uint32 max_sent_receivers = 2; optional uint32 max_received_actions = 3; optional uint32 max_received_receivers = 4; // ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp end_date = 5; DataroomMode mode = 6; } +----------------------------+-------------------------------+-------------+ | Field | Type | Description | +============================+===============================+=============+ | ``max_sent_actions`` | ``uint32`` | optional | +----------------------------+-------------------------------+-------------+ | ``max_sent_receivers`` | ``uint32`` | optional | +----------------------------+-------------------------------+-------------+ | ``max_received_actions`` | ``uint32`` | optional | +----------------------------+-------------------------------+-------------+ | ``max_received_receivers`` | ``uint32`` | optional | +----------------------------+-------------------------------+-------------+ | ``end_date`` | ``google.protobuf.Timestamp`` | optional | +----------------------------+-------------------------------+-------------+ | ``mode`` | ``DataroomMode`` | | +----------------------------+-------------------------------+-------------+ .. _Dataroom: Dataroom -------- The basic data room object. Please be aware that not all attributes are always used/returned. This depends on the data room type and/or context in which this object is used. .. code-block:: json message Dataroom { string id = 1; string name = 2; string type = 3; optional string document_class = 4; string author = 5; string title = 6; string path = 7; // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp creation_date = 9; // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp modification_date = 10; string icon = 11; uint32 num_children = 14; optional bool access_allowed = 61; // user dependent optional bool is_dataroom_admin = 15; // user dependent optional bool is_group_admin = 16; // user dependent optional AccessDeniedReasons access_denied_reason = 17; // user dependent DataroomType dataroom_type = 62; optional Disclaimer disclaimer = 63; ItemType item_type = 64; EffectivePermission effective_permission = 65; optional bool is_unconfirmed = 66; // user dependent // user dependent // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp date_open = 67; // user dependent // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp date_close = 68; optional string responsible_username = 69; optional string responsible_user_realname = 70; /* The mountpoint exists always. Even if there is no mountpoint set explicitly. In such a case, it is the ID of 'projectfiles', i.e. the root of document entries. */ optional string mountpoint = 71; optional bool e2ee = 72; // End-2-End Encrypted optional uint64 current_quantum = 73; optional uint64 free_quantum = 74; optional uint64 max_quantum = 75; optional uint32 current_users = 76; optional uint32 max_users = 77; optional uint32 free_users = 78; optional uint64 max_filesize = 79; // user dependent // ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp date_last_change = 80; optional bool is_vue_dataroom = 81; optional DealroomStatus dealroom_status = 82; optional bool is_archive_dataroom = 83; optional string ft_index_language = 84; optional string comment = 86; optional string cost_center = 87; optional string e2ee_user_key = 85; // user dependent optional TemplateInfo template_info = 88; optional SendInfo send_info = 89; optional string parent_id = 90; optional string dataroom_id = 91; optional bool use_ms_teams = 92; optional bool allow_machine_translation = 93; optional uint64 total_deep_l_used_characters = 100; } +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Field | Type | Description | +==================================+===============================+=================================================================================================================================================================================+ | ``id`` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``name`` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``type`` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``document_class`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``author`` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``title`` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``path``` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``creation_date`` | ``google.protobuf.Timestamp`` | **Optional.** rotoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``modification_date`` | ``google.protobuf.Timestamp`` | **Optional.** rotoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``icon`` | ``string`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``num_children`` | ``uint32`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``access_allowed`` | ``bool`` | **Optional.** User dependent. | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``is_dataroom_admin`` | ``bool`` | **Optional.** User dependent. | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``is_group_admin`` | ``bool`` | **Optional.** User dependent. | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``access_denied_reason`` | ``AccessDeniedReasons`` | **Optional.** User dependent. | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``dataroom_type`` | ``DataroomType`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``disclaimer`` | ``Disclaimer``` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``item_type`` | ``ItemType`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``effective_permission`` | ``EffectivePermission`` | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``is_unconfirmed`` | ``bool`` | **Optional.** User dependent. | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``date_open`` | ``google.protobuf.Timestamp`` | **Optional.** User dependent. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``date_close`` | ``google.protobuf.Timestamp`` | **Optional.** User dependent. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``responsible_username`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``responsible_user_realname`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``mountpoint`` | ``string`` | **Optional.** The mountpoint exists always. Even if there is no mountpoint set explicitly. In such a case, it is the ID of ``projectfiles``, i.e. the root of document entries. | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``e2ee`` | ``bool`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``current_quantum`` | ``uint64`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``free_quantum`` | ``uint64`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``max_quantum`` | ``uint64`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``current_users`` | ``uint32`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``max_users`` | ``uint32`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``free_users`` | ``uint32`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``max_filesize`` | ``uint64`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``date_last_change`` | ``google.protobuf.Timestamp`` | **Optional.** ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/ | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``is_vue_dataroom`` | ``bool`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``dealroom_status`` | ``DealroomStatus`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``is_archive_dataroom`` | ``bool`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``ft_index_language`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``comment`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``cost_center`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``e2ee_user_key`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``template_info`` | ``TemplateInfo`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``send_info`` | ``SendInfo`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``parent_id`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``dataroom_id`` | ``string`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``use_ms_teams`` | ``bool`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``allow_machine_translation`` | ``bool`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``total_deep_l_used_characters`` | ``uint64`` | **Optional.** | +----------------------------------+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _SettingsEntryAsUser: SettingsEntryAsUser ------------------- One setting with user array as value .. code-block:: json message SettingsEntryAsMultiUser { repeated User value = 1; optional bool editable = 2; optional string field_type = 3; optional string tooltip_type = 4; } +------------------+-------------------+--------------+ | Field | Type | Description | +==================+===================+==============+ | ``value``` | array of ``User`` | | +------------------+-------------------+--------------+ | ``editable``` | ``bool`` | **Optional** | +------------------+-------------------+--------------+ | ``field_type``` | ``string`` | **Optional** | +------------------+-------------------+--------------+ | ``tooltip_type`` | ``string`` | **Optional** | +------------------+-------------------+--------------+ .. _SettingsEntryAsNewDataroomType: SettingsEntryAsNewDataroomType ------------------------------ Data room type as setting .. code-block:: json message SettingsEntryAsNewDataroomType { NewDataroomType value = 1; optional bool editable = 2; optional string field_type = 3; optional string tooltip_type = 4; } +------------------+---------------------+--------------+ | Field | Type | Description | +==================+=====================+==============+ | ``value``` | ``NewDataroomType`` | | +------------------+---------------------+--------------+ | ``editable``` | ``bool`` | **Optional** | +------------------+---------------------+--------------+ | ``field_type``` | ``string`` | **Optional** | +------------------+---------------------+--------------+ | ``tooltip_type`` | ``string`` | **Optional** | +------------------+---------------------+--------------+ .. _CopyDataroom: CopyDataroom ------------ Values for copying a data room .. code-block:: json message CopyDataroom { string title = 10; optional string name = 11; uint32 max_users = 12; uint64 max_quantum = 13; string cost_center = 17; string dataroom_id = 18; bool copy_content = 19; bool copy_users = 20; bool copy_groups = 21; bool copy_rights = 22; repeated User admins = 16; } +------------------+-------------------+---------------+ | Field | Type | Description | +==================+===================+===============+ | ``title`` | ``string`` | | +------------------+-------------------+---------------+ | ``name`` | ``string`` | **Optional.** | +------------------+-------------------+---------------+ | ``max_users`` | ``uint32`` | | +------------------+-------------------+---------------+ | ``max_quantum`` | ``uint64`` | | +------------------+-------------------+---------------+ | ``cost_center`` | ``string`` | | +------------------+-------------------+---------------+ | ``dataroom_id`` | ``string`` | | +------------------+-------------------+---------------+ | ``copy_content`` | ``bool`` | | +------------------+-------------------+---------------+ | ``copy_users`` | ``bool`` | | +------------------+-------------------+---------------+ | ``copy_groups`` | ``bool`` | | +------------------+-------------------+---------------+ | ``copy_rights`` | ``bool`` | | +------------------+-------------------+---------------+ | ``admins`` | Array of ``User`` | | +------------------+-------------------+---------------+ .. _NewDataroom: NewDataroom ----------- Values for creating a new data room .. code-block:: json message NewDataroom { string title = 10; optional string name = 11; uint32 max_users = 12; uint64 max_quantum = 13; repeated User admins = 16; optional string cost_center = 17; string dataroom_template_id = 18; } +--------------------------+-------------------+---------------+ | Field | Type | Description | +==========================+===================+===============+ | ``title`` | ``string`` | | +--------------------------+-------------------+---------------+ | ``name`` | ``string`` | **Optional.** | +--------------------------+-------------------+---------------+ | ``max_users`` | ``uint32`` | | +--------------------------+-------------------+---------------+ | ``max_quantum`` | ``uint64`` | | +--------------------------+-------------------+---------------+ | ``admins`` | array of ``User`` | | +--------------------------+-------------------+---------------+ | ``cost_center`` | ``string`` | **Optional.** | +--------------------------+-------------------+---------------+ | ``dataroom_template_id`` | ``string`` | | +--------------------------+-------------------+---------------+ .. _EnterpriseDataroomProperties: EnterpriseDataroomProperties ---------------------------- Properties of a data room when viewed via enterprise environment .. code-block:: json message EnterpriseDataroomProperties { string id = 1; string name = 2; SettingsEntryAsString title = 6; // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp creation_date = 9; // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp modification_date = 10; DataroomType dataroom_type = 62; optional uint64 current_quantum = 73; optional uint64 free_quantum = 74; optional SettingsEntryAsNumber max_quantum = 75; optional uint32 current_users = 76; optional SettingsEntryAsNumber max_users = 77; optional uint32 free_users = 78; optional SettingsEntryAsNumber max_filesize = 79; // ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp date_last_change = 80; optional SettingsEntryAsString comment = 86; optional SettingsEntryAsString cost_center = 87; } +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | Field | Type | Description | +=======================+===============================+======================================================================================+ | ``id`` | ``string`` | | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``name`` | ``string`` | | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``title`` | ``SettingsEntryAsString`` | | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``creation_date`` | ``google.protobuf.Timestamp`` | **Optional.** ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``modification_date`` | ``google.protobuf.Timestamp`` | **Optional.** ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``dataroom_type`` | ``DataroomType`` | | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``current_quantum`` | ``uint64`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``free_quantum`` | ``uint64`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``max_quantum`` | ``SettingsEntryAsNumber`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``current_users`` | ``uint32`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``max_users`` | ``SettingsEntryAsNumber`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``free_users`` | ``uint32`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``max_filesize`` | ``SettingsEntryAsNumber`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``date_last_change`` | ``google.protobuf.Timestamp`` | **Optional.** ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``comment`` | ``SettingsEntryAsString`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+ | ``cost_center`` | ``SettingsEntryAsString`` | **Optional.** | +-----------------------+-------------------------------+--------------------------------------------------------------------------------------+