Bookmark

Bookmark

A single bookmark object in the database.

message Bookmark {
 string id = 1;
 string dataroom_id = 2;
 string parent_id = 3;
 string name = 4;
 string type = 5;
 string author = 6;
 string title = 7;
 optional string path = 8;
 string url = 9;
 google.protobuf.Timestamp creation_date = 11;
 google.protobuf.Timestamp modification_date = 12;
 EffectivePermission effective_permission = 15;
 string mime_type = 16;
 optional string sequence = 17;
 optional string index = 18;
 optional bool no_index = 24;
 optional string parent_title = 25;
 string description = 19;
 string document_class = 20;
 repeated ItemPermissionsEntry permissions = 22;
 optional Labels labels = 23;
 ItemType item_type = 31;
 optional bool has_different_parent_rights = 35;
 optional uint32 comments_count = 36;
 optional Parent parent = 37;
}

Field	Type	Description
id	string
dataroom_id	string
parent_id	string
name	string
type	string
author	string
title	string
path	string	optional
url	string
creation_date	google.protobuf.Timestamp
modification_date	google.protobuf.Timestamp
effective_permission	EffectivePermission
mime_type	string
sequence	string	optional
index	string	optional
no_index	boolean	optional
parent_title	string	optional
description	string
document_class	string
permissions	array of ItemPermissionsEntry	repeated
labels	Labels	optional
item_type	ItemType
has_different_parent_rights	bool	optional
comments_count	uint32	optional
parent	Parent	optional

BookmarkProperties

The Properties Object representing the bookmark’s properties.

Technically, this is the data shown in any “properties”-dialog

message BookmarkProperties {
 string id = 1;
 optional SettingsEntryAsString name = 4;
 optional SettingsEntryAsString author = 6;
 optional SettingsEntryAsString title = 7;
 optional SettingsEntryAsString sequence = 8;
 optional SettingsEntryAsString index = 9;
 optional SettingsEntryAsString no_index = 11;
 optional SettingsEntryAsString path = 10;
 optional SettingsEntryAsDate creation_date = 14;
 optional SettingsEntryAsDate modification_date = 15;
 optional SettingsEntryAsString description = 19;
 optional SettingsEntryAsString tags = 22;
 optional SettingsEntryAsString url = 23;
 optional SettingsEntryAsDate deletion_date = 38;
 optional SettingsEntryAsBool has_different_parent_rights = 35;
 ItemType item_type = 31;
 optional ItemSubType item_subtype = 32;
}

Field	Type	Description
id	string
name	SettingsEntryAsString	optional
author	SettingsEntryAsString	optional
title	SettingsEntryAsString	optional
sequence	SettingsEntryAsString	optional
index	SettingsEntryAsString	optional
no_index	SettingsEntryAsString	optional
path	SettingsEntryAsString	optional
creation_date	SettingsEntryAsDate	optional
modification_date	SettingsEntryAsDate	optional
description	SettingsEntryAsString	optional