IRPCViews.CopyView
Vault API / standard write session or assertion returns metadata structure version
Copies a private view that another user has shared, with its child views, into the caller's own views.
| Service | Views MFiles.IRPCViews |
|---|---|
| gRPC method | /MFiles.IRPCViews/CopyView |
| HTTP (mf-http-grpc) | POST /grpc/v1/copy-view |
| Request | CopyViewRequest |
| Response | CopyViewResponse |
| 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
- The owner must first share the view with EnableShareView. Otherwise the call fails with "This view is not shared with you.". The sharing expires after the number of days that EnableShareView returns (14 by default).
- Common views cannot be copied.
- The copy is a new private view at the top level of the caller's views; its child views are copied with it. Vault event handlers for views run.
Request: CopyViewRequest
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 |
|---|---|---|
view_id | ItemID | The ID of the shared view (internal_id). |
view_id.internal_id | int32 | The ID of the object or value list item. |
view_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
view_id.external_repository_id.connection | string | The external repository connection identifier. |
view_id.external_repository_id.item | string | External ID within the scope of the connection to external system. |
Response: CopyViewResponse
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 |
|---|---|---|
putf8szviews[] | repeated View | The new view and its copied child views. |
putf8szviews[].id | int32 | The ID of the view. |
putf8szviews[].type | ViewType | The type of the view.Values: VIEW_TYPE_SHOW_OBJECTS (0), VIEW_TYPE_FILTER_ONLY (1). |
putf8szviews[].name | string | The name of the view. |
putf8szviews[].is_common | bool | Tells if the view is admin-defined (common) or user-defined. |
putf8szviews[].is_visible | bool | Tells if the view is visible. |
putf8szviews[].location | ViewLocation | The location of the view. Valid only if bHasParent is true. |
putf8szviews[].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. |
putf8szviews[].location.customizes_property_folder | bool | True if the view is overlapping with a property folder. |
putf8szviews[].location.customized_property_folder | TypedValue | The overlapped property folder. Ignored if bOverlapping is false. |
putf8szviews[].content_definition | SearchDef | The search definition that contains the view levels and search conditions of the view. |
putf8szviews[].content_definition.filter_conditions[] | repeated SearchCondition | The conditions that limit the object set of this search. |
putf8szviews[].content_definition.grouping_levels[] | repeated GroupingLevel | View levels (the display hierarchy of this search). |
putf8szviews[].content_definition.options | SearchFlags | Search flags. This affects the resulting object version set and also distinct view level values displayed inside this search. |
putf8szviews[].acl | AccessControlList | Permissions. |
putf8szviews[].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. |
putf8szviews[].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. |
putf8szviews[].acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
putf8szviews[].acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
putf8szviews[].acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
putf8szviews[].acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
putf8szviews[].flags_obsolete | uint32 | Bit flags that provide additional information on the view. |
putf8szviews[].options | VIEWFLAGS | Bit flags that provide additional information on the view. |
putf8szviews[].options.all | bool | Specifies all flags set; Including any future flags. |
putf8szviews[].options.indexed | bool | Materialized/indexed view. |
putf8szviews[].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. |
putf8szviews[].options.sort_across_all_pages_disabled | bool | Sorting search results is disabled. |
putf8szviews[].guid | string | GUID for the view. |
putf8szviews[].view_visualization | ViewVisualization | View visualization information. |
putf8szviews[].view_visualization.subview_groups[] | repeated SubviewGroup | The subviews of the view as groups. |
Related methods
- EnableShareView -- Allows other users to copy the given private views of the caller for a limited time.