ValueList
Object type, basic data.
Name | Description | Type |
---|---|---|
id | Object type ID. | number |
name_singular | The name of the object type. | string |
name_plural | The value list name of the object type. | string |
icon | Icon in .ICO format (contains multiple sizes and color depths). | Uint8Array |
is_real_object_type | Is a real object type (not just a value list)? | boolean |
is_hierarchical | Is hierarchical? | boolean |
has_owner | Has owner? | boolean |
owner_object_type | The owner object type for filtering. | number |
owner_property_def | Owner property def. Subobjects of objects of this object type have this property in their meta data for describing owner relationships. | number |
options | Object type flags. | OBJTYPEFLAGS |
default_property_def | The ID of the mslookup propertydef that acts as the default propertydef for this object type. For example, new relationships to objects of this type are expressed using this propertydef. | number |
read_only_properties_during_insert | 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. | number[] |
read_only_properties_during_update | 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. | number[] |
acl | 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. | AccessControlList |
default_acl_for_objects | Default ACL for new items/objects of this type. If NULL, the global default is used (vlitems: read access to all internal users; real objects: full control for all internal users). | AccessControlList |
vl_sorting_type_reserved | 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. | VLSortingType |
sort_ascending_reserved | 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. | boolean |
guid | GUID for the OT. | string |
preferred_title_property_def_id | Property definition ID of the title property for the user's preferred language. | number |
search_characteristics | If not NULL, specifies search characteristics of the object type. | ObjectTypeSearchCharacteristics |
Example
{
"id": 0,
"name_singular": "<!< The name of the object type.>",
"name_plural": "<!< The value list name of the object type.>",
"icon": 0 /*Uint8Array*/,
"is_real_object_type": false,
"is_hierarchical": false,
"has_owner": false,
"owner_object_type": 0,
"owner_property_def": 0,
"options": {
"all": false,
"can_have_files": false,
"can_add_items": false,
"is_external": false,
"show_new_object_command_in_task_pane": false,
"is_external_connection_disabled": false,
"is_translatable": false,
"is_separate_property_storage": false,
"disallow_as_grouping_level": false
},
"default_property_def": 0,
"read_only_properties_during_insert": [] /* Array of number */,
"read_only_properties_during_update": [] /* Array of number */,
"acl": {
"checked_out_to_user": 0,
"is_fully_authoritative": false,
"custom_component": {
"named_acl_id": 0,
"has_named_acl": false,
"current_user_id": 0,
"has_current_user": false,
"permissions": [] /* Array of AccessControlEntry */,
"overridability_permissions": [] /* Array of AccessControlEntry */,
"status": {
"all": false,
"deleted": false,
"source_item_linked_via_pseudo_users": false
}
},
"restrictive_components": [] /* Array of AccessControlListComponentMapEntry */,
"secondary_access_control_list": {} /* AccessControlList */,
"additive_components": [] /* Array of AccessControlListComponentMapEntry */
},
"default_acl_for_objects": {} /* AccessControlList */,
"vl_sorting_type_reserved": 1 /* Enum: VLSortingType */,
"sort_ascending_reserved": false,
"guid": "<!< GUID for the OT.>",
"preferred_title_property_def_id": 0,
"search_characteristics": {
"exclude_in_entire_file_data_search": false,
"exclude_in_entire_meta_data_search": false
}
}