Short Cut

Contents

Short Cut#

Shortcut#

Represents some sort of symbolic link for a document. The attribute target_id specifies the id of the original document.

message Shortcut {
 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;
 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 = 21;
 string description = 19;
 string document_class = 20;
 repeated ItemPermissionsEntry permissions = 22;
 optional Labels labels = 23;
 optional string target_id = 24;
 optional string target_version = 25;
 optional string parent_title = 26;
 ItemType item_type = 31;
 optional bool has_different_parent_rights = 35;
 optional ItemType target_type = 32;
 optional uint32 comments_count = 36;
 optional Parent parent = 37;
 optional uint32 document_size = 10;
}

Field	Type	Description
`id`	`string`
`dataroom_id`	`string`
`parent_id`	`string`
`name`	`string`
`type`	`string`
`author`	`string`
`title`	`string`
`path`	`string`	Optional.
`creation_date`	`google.protobuf.Timestamp`
`modification_date`	`google.protobuf.Timestamp`
`effective_permission`	`EffectivePermission`	See EffectivePermission
`mime_type`	`string`
`sequence`	`string`	Optional.
`index`	`string`	Optional.
`no_index`	`bool`	Optional.
`description`	`string`
`document_class`	`string`
`permissions`	array of `ItemPermissionsEntry`	See ItemPermissionsEntry
`labels`	`Labels`	Optional. See Labels
`target_id`	`string`	Optional.
`target_version`	`string`	Optional.
`parent_title`	`string`	Optional.
`item_type`	`ItemType`	See ItemType
`has_different_parent_rights`	`bool`	Optional.
`target_type`	`ItemType`	Optional. See ItemType
`comments_count`	`uint32`	Optional.
`parent`	`Parent`	Optional. See Parent
`document_size`	`uint32`	Optional.

ShortcutProperties#

Properties of a shortcut

message ShortcutProperties {
 string id = 1;
 optional SettingsEntryAsString name = 4;
 optional SettingsEntryAsString author = 6;
 optional SettingsEntryAsString title = 7;
 optional SettingsEntryAsString sequence = 8;
 optional SettingsEntryAsString index = 9;
 optional SettingsEntryAsBool no_index = 12;
 optional SettingsEntryAsString path = 10;
 optional SettingsEntryAsString tags = 11;
 optional SettingsEntryAsDate creation_date = 14;
 optional SettingsEntryAsDate modification_date = 15;
 optional SettingsEntryAsString description = 19;
 optional SettingsEntryAsString target_title = 20;
 optional SettingsEntryAsString target_path = 21;
 optional SettingsEntryAsDate deleted_on = 38;
 optional SettingsEntryAsBool has_different_parent_rights = 35;
 ItemType item_type = 31;
 optional ItemType target_type = 32;
}

Field	Type	Description
`name`	`SettingsEntryAsString`	See SettingsEntryAsString
`author`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`title`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`sequence`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`index`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`no_index`	`SettingsEntryAsBool`	Optional. See SettingsEntryAsBool
`path`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`tags`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`creation_date`	`SettingsEntryAsDate`	Optional. See SettingsEntryAsDate
`modification_date`	`SettingsEntryAsDate`	Optional. See SettingsEntryAsDate
`description`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`target_title`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`target_path`	`SettingsEntryAsString`	Optional. See SettingsEntryAsString
`deleted_on`	`SettingsEntryAsDate`	Optional. See SettingsEntryAsDate
`has_different_parent_rights`	`SettingsEntryAsBool`	Optional. See SettingsEntryAsBool
`item_type`	`ItemType`	See ItemType
`target_type`	`ItemType`	Optional. See ItemType