ValueList
An object type or a value list (basic definition). Despite the name, this message describes
both: is_real_object_type is true for object types, whose items are objects.
Returned by GetObjectTypes,
GetObjectType,
GetValueLists and
GetValueList. Lists that the caller is not allowed
to see are returned with empty names and object_type_permissions.can_user_see false.
| Full name | MFiles.ValueList |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
id | int32 | 1 | The ID of the object type or value list. Object types and value lists share one ID space; property definition IDs and item IDs are separate spaces. |
name_singular | string | 2 | The singular name, for example "Customer". Empty if the caller is not allowed to see the list. |
name_plural | string | 3 | The plural name, for example "Customers". Empty if the caller is not allowed to see the list. |
icon | bytes | 4 | The icon in .ICO format. Filled only by GetObjectTypes and GetObjectType, and only for real object types; empty in GetValueLists and GetValueList. |
is_real_object_type | bool | 5 | True for an object type, whose items are objects (documents, customers); false for a plain value list (Country, Classes, Users). |
is_hierarchical | bool | 6 | True if items can have a parent item in the same list (ValueListItem.has_parent). |
has_owner | bool | 7 | True if every item belongs to an item of another list, the owner list (owner_object_type). For example, contact persons are owned by customers. |
owner_object_type | int32 | 8 | With has_owner, the ID of the owner list or object type. |
owner_property_def | int32 | 9 | Owner property def. Subobjects of objects of this object type have this property in their meta data for describing owner relationships. |
options | OBJTYPEFLAGS | 10 | Flags of the list, for example can_add_items and is_external. See OBJTYPEFLAGS. |
default_property_def | int32 | 11 | The ID of the lookup property definition that refers to items of this list by default, for example 1079 (Customer) for the Customer object type. |
read_only_properties_during_insert | repeated int32 | 12 | The propertydef IDs of those properties that cannot be entered during the creation of a new object because they are not included in the INSERT INTO statement. |
read_only_properties_during_update | repeated int32 | 13 | The propertydef IDs of those properties that cannot be entered during the editing of an existing object because they are not included in the UPDATE statement. |
targets_for_browsing | repeated ObjectTypeTargetForBrowsing | 14 | Object type targets for browsing. |
acl | AccessControlList | 15 | Specifies the ACL that defines the visibility and other permission settings of this object type. Also specifies who can add new items to this object type. |
object_type_permissions | ObjectTypePermissionsForClient | 20 | What the caller may do with the list: see it (can_user_see) and add items or objects (can_user_add_new_items). Filled by the read calls of IRPCObjectTypes and IRPCValueLists. |
default_acl_for_objects | AccessControlList | 16 | Default ACL for new items/objects of this type. If unset, the global default is used (vlitems: read access to all internal users; real objects: full control for all internal users). |
vl_sorting_type_reserved | VLSortingType | 17 | The sorting type of value list items. NOTE: This value is not currently used but is reserved for future use. Currently, sorting order is specified on the property definition level only.Values: VLSORTING_TYPE_BY_DISPLAY_NAME (0), VLSORTING_TYPE_BY_EXTERNAL_ID (1). |
sort_ascending_reserved | bool | 18 | True to sort in ascending order, false to sort in descending order. NOTE: This value is not currently used but is reserved for future use. Currently, sorting order is specified on the property definition level only. |
guid | string | 19 | The GUID of the object type or value list, with braces. Resolve it to the vault's ID with GetMetadataStructureItemIdByGUID. |
preferred_title_property_def_id | int32 | 21 | Property definition ID of the title property for the user's preferred language. |
search_characteristics | ObjectTypeSearchCharacteristics | 22 | If set, specifies search characteristics of the object type. |
indexing_definition | ObjectTypeIndexingDefinition | 23 | If set, defines the indexed value lists and properties of the object type. Used for searching from Master Storage. |
view_id | int32 | 24 | The ID of the object type specific view. |
Used by methods
- IRPCObjectTypes.GetObjectType -- Gets one object type or value list by ID, with its icon.
- IRPCObjectTypes.GetObjectTypes -- Gets all object types (real object types only, not plain value lists), with their icons.
- IRPCValueLists.GetValueList -- Gets one value list or object type by ID, without its icon.
- IRPCValueLists.GetValueLists -- Gets all value lists of the vault, including the object types, without icons.
Used in fields
ObjectTypeAndValueListStructureResponse.object_types_and_value_lists-- The object type and value list entries.ValueListAdmin.object_type-- Basic data.GetObjectTypesResponse.object_types-- The real object types of the vault, including those the user cannot see (with empty names). See ValueList.GetObjectTypeResponse.putf8szobjtypebasic-- The object type or value list. See ValueList.GetValueListsResponse.value_lists-- All value lists and object types, including those the user cannot see (with empty names). See ValueList.GetValueListResponse.object_type_basic-- The value list. See ValueList.