Skip to main content

View

Struct for a single view.

NameDescriptionType
idThe ID of the view.number
typeThe type of the view.ViewType
nameThe name of the view.string
is_commonTells if the view is admin-defined (common) or user-defined.boolean
is_visibleTells if the view is visible.boolean
locationThe location of the view. Valid only if bHasParent is true.ViewLocation
content_definitionThe search definition that contains the view levels and search conditions of the view.SearchDef
aclPermissions.AccessControlList
flags_obsoleteBit flags that provide additional information on the view.number
optionsBit flags that provide additional information on the view.VIEWFLAGS
guidGUID for the view.string
view_visualizationView visualization information.ViewVisualization

Example

{
"id": 0,
"type": 1 /* Enum: ViewType */,
"name": "<name>",
"is_common": false,
"is_visible": false,
"location": {
"parent_folder": [] /* Array of Folder */,
"customizes_property_folder": false,
"customized_property_folder": {
"is_null_value": false,
"type": 15 /* Enum: Datatype */,
"data": {
"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 */
}
}
}
},
"content_definition": {
"filter_conditions": [] /* Array of SearchCondition */,
"grouping_levels": [] /* Array of GroupingLevel */,
"options": {
"all": false,
"look_in_all_versions": false,
"return_latest_visible_version": false,
"separately_search_in_each_object_type": false,
"allow_quick_refresh_for_external_object_types": false,
"disable_relevancy_ranking": false,
"separately_search_specific_object_types": false,
"include_unmanaged_objects": false,
"individual_limit_for_each_external_repository": false
}
},
"acl": {} /* AccessControlList */,
"flags_obsolete": 0,
"options": {
"all": false,
"indexed": false,
"incompatible_with_full_text_search": false,
"sort_across_all_pages_disabled": false
},
"guid": "<guid>",
"view_visualization": {
"subview_groups": [] /* Array of SubviewGroup */
}
}