IRPCViews.GetViews
Vault API / standard write session or assertion returns metadata structure version
Gets the calling user's view collection: all views, or the direct child views of one view.
| Service | Views MFiles.IRPCViews |
|---|---|
| gRPC method | /MFiles.IRPCViews/GetViews |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-views |
| Request | GetViewsRequest |
| Response | GetViewsResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires a vault session. No special vault rights are needed. Common views that the user may not see and other users' private views are left out.
- Hidden views are included; check
View.is_visible. - With
get_all_viewsfalse, setparent_view: -1 returns the top-level views. The default 0 is not the top level and returns nothing. - The order of the views is not specified. Lookup values in search conditions are returned in the session's vault language.
- To keep a local copy in sync, use GetViewsOrDelta instead.
Request: GetViewsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
get_all_views | bool | True to get every view in the user's collection. Then parent_view is ignored. |
parent_view | int32 | With get_all_views false, the ID of the view whose direct child views to get, or -1 for the top-level views. |
Response: GetViewsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
views[] | repeated View | The views. See View. |
views[].id | int32 | The ID of the view. |
views[].type | ViewType | The type of the view.Values: VIEW_TYPE_SHOW_OBJECTS (0), VIEW_TYPE_FILTER_ONLY (1). |
views[].name | string | The name of the view. |
views[].is_common | bool | Tells if the view is admin-defined (common) or user-defined. |
views[].is_visible | bool | Tells if the view is visible. |
views[].location | ViewLocation | The location of the view. Valid only if bHasParent is true. |
views[].location.parent_folder[] | repeated Folder | Array of folders describing the parent folder of the view. The first element of the array must be a view folder. Other elements, if any, are property folders. |
views[].location.customizes_property_folder | bool | True if the view is overlapping with a property folder. |
views[].location.customized_property_folder | TypedValue | The overlapped property folder. Ignored if bOverlapping is false. |
views[].content_definition | SearchDef | The search definition that contains the view levels and search conditions of the view. |
views[].content_definition.filter_conditions[] | repeated SearchCondition | The conditions that limit the object set of this search. |
views[].content_definition.grouping_levels[] | repeated GroupingLevel | View levels (the display hierarchy of this search). |
views[].content_definition.options | SearchFlags | Search flags. This affects the resulting object version set and also distinct view level values displayed inside this search. |
views[].acl | AccessControlList | Permissions. |
views[].acl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
views[].acl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
views[].acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
views[].acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
views[].acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
views[].acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
views[].flags_obsolete | uint32 | Bit flags that provide additional information on the view. |
views[].options | VIEWFLAGS | Bit flags that provide additional information on the view. |
views[].options.all | bool | Specifies all flags set; Including any future flags. |
views[].options.indexed | bool | Materialized/indexed view. |
views[].options.incompatible_with_full_text_search | bool | The search conditions of the view definition (excluding the grouping levels) are not compatible with full-text search. |
views[].options.sort_across_all_pages_disabled | bool | Sorting search results is disabled. |
views[].guid | string | GUID for the view. |
views[].view_visualization | ViewVisualization | View visualization information. |
views[].view_visualization.subview_groups[] | repeated SubviewGroup | The subviews of the view as groups. |
Related methods
- GetViewsOrDelta -- Gets the calling user's whole view collection, or only the changes since a version the caller already has.