IRPCViews.ModifyView
Vault API / standard write session or assertion idempotent returns metadata structure version
Replaces the definition of an existing view.
| Service | Views MFiles.IRPCViews |
|---|---|
| gRPC method | /MFiles.IRPCViews/ModifyView |
| HTTP (mf-http-grpc) | POST /grpc/v1/modify-view |
| Request | ModifyViewRequest |
| Response | ModifyViewResponse |
| 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 | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Send the complete view, identified by
id: read it first, change what you need and send it back. - Private views need
manage_private_views; common views (or turning a common view into a private one, or the other way round) needmanage_common_views. Only the owner can modify a private view; for other users it fails with "Not found.". - Some built-in views cannot be changed at all, for example 12, 13, 15, 16, 17, 18 and 23. Of the views under Built-in (13) only the name and ACL can be changed, and of the views under All object types (23) only the visualization.
- If the grouping levels change, child views that are inside the grouping levels are deleted.
- A common view can be made private only if all its child views are the caller's own private views.
- The duplicate-name and indexing rules of AddNewView apply. Vault event handlers for views run.
Request: ModifyViewRequest
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 |
|---|---|---|
utf8szview | View | The complete new definition of the view, with the id of the view to change. |
utf8szview.id | int32 | The ID of the view. |
utf8szview.type | ViewType | The type of the view.Values: VIEW_TYPE_SHOW_OBJECTS (0), VIEW_TYPE_FILTER_ONLY (1). |
utf8szview.name | string | The name of the view. |
utf8szview.is_common | bool | Tells if the view is admin-defined (common) or user-defined. |
utf8szview.is_visible | bool | Tells if the view is visible. |
utf8szview.location | ViewLocation | The location of the view. Valid only if bHasParent is true. |
utf8szview.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. |
utf8szview.location.customizes_property_folder | bool | True if the view is overlapping with a property folder. |
utf8szview.location.customized_property_folder | TypedValue | The overlapped property folder. Ignored if bOverlapping is false. |
utf8szview.content_definition | SearchDef | The search definition that contains the view levels and search conditions of the view. |
utf8szview.content_definition.filter_conditions[] | repeated SearchCondition | The conditions that limit the object set of this search. |
utf8szview.content_definition.grouping_levels[] | repeated GroupingLevel | View levels (the display hierarchy of this search). |
utf8szview.content_definition.options | SearchFlags | Search flags. This affects the resulting object version set and also distinct view level values displayed inside this search. |
utf8szview.acl | AccessControlList | Permissions. |
utf8szview.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. |
utf8szview.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. |
utf8szview.acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
utf8szview.acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
utf8szview.acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
utf8szview.acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
utf8szview.flags_obsolete | uint32 | Bit flags that provide additional information on the view. |
utf8szview.options | VIEWFLAGS | Bit flags that provide additional information on the view. |
utf8szview.options.all | bool | Specifies all flags set; Including any future flags. |
utf8szview.options.indexed | bool | Materialized/indexed view. |
utf8szview.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. |
utf8szview.options.sort_across_all_pages_disabled | bool | Sorting search results is disabled. |
utf8szview.guid | string | GUID for the view. |
utf8szview.view_visualization | ViewVisualization | View visualization information. |
utf8szview.view_visualization.subview_groups[] | repeated SubviewGroup | The subviews of the view as groups. |
Response: ModifyViewResponse
No fields.
Related methods
- AddNewView -- Creates a new private or common view.