IRPCWorkspace.CreateTemporaryWorkspaceView
Vault API / standard write session or assertion returns metadata structure version
Builds the definitions of a new workspace tab view and its reverse view for a pair of object types, without saving the views.
| Service | Workspaces MFiles.IRPCWorkspace |
|---|---|
| gRPC method | /MFiles.IRPCWorkspace/CreateTemporaryWorkspaceView |
| HTTP (mf-http-grpc) | POST /grpc/v1/create-temporary-workspace-view |
| Request | CreateTemporaryWorkspaceViewRequest |
| Response | CreateTemporaryWorkspaceViewResponse |
| 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.
- Both IDs must be real object types; a value list fails with "The parameter is incorrect.".
- The returned views are not saved and have no name. They are located under the pair's filter-only view and give read access to all users. Set the name and any other fields, then save a view with AddNewView.
- Side effect: the first call for a pair of object types creates and saves the pair's hidden filter-only view, which later calls reuse.
Request: CreateTemporaryWorkspaceViewRequest
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 |
|---|---|---|
source_object_type_id | int32 | The object type of the object whose workspace shows the tab. |
target_object_type_id | int32 | The object type of the related objects that the tab lists. |
Response: CreateTemporaryWorkspaceViewResponse
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 |
|---|---|---|
view | View | The tab view, not yet saved. |
view.id | int32 | The ID of the view. |
view.type | ViewType | The type of the view.Values: VIEW_TYPE_SHOW_OBJECTS (0), VIEW_TYPE_FILTER_ONLY (1). |
view.name | string | The name of the view. |
view.is_common | bool | Tells if the view is admin-defined (common) or user-defined. |
view.is_visible | bool | Tells if the view is visible. |
view.location | ViewLocation | The location of the view. Valid only if bHasParent is true. |
view.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. |
view.location.customizes_property_folder | bool | True if the view is overlapping with a property folder. |
view.location.customized_property_folder | TypedValue | The overlapped property folder. Ignored if bOverlapping is false. |
view.content_definition | SearchDef | The search definition that contains the view levels and search conditions of the view. |
view.content_definition.filter_conditions[] | repeated SearchCondition | The conditions that limit the object set of this search. |
view.content_definition.grouping_levels[] | repeated GroupingLevel | View levels (the display hierarchy of this search). |
view.content_definition.options | SearchFlags | Search flags. This affects the resulting object version set and also distinct view level values displayed inside this search. |
view.acl | AccessControlList | Permissions. |
view.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. |
view.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. |
view.acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
view.acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
view.acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
view.acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
view.flags_obsolete | uint32 | Bit flags that provide additional information on the view. |
view.options | VIEWFLAGS | Bit flags that provide additional information on the view. |
view.options.all | bool | Specifies all flags set; Including any future flags. |
view.options.indexed | bool | Materialized/indexed view. |
view.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. |
view.options.sort_across_all_pages_disabled | bool | Sorting search results is disabled. |
view.guid | string | GUID for the view. |
view.view_visualization | ViewVisualization | View visualization information. |
view.view_visualization.subview_groups[] | repeated SubviewGroup | The subviews of the view as groups. |
reverse | View | The view in the reverse direction, not yet saved. |
reverse.id | int32 | The ID of the view. |
reverse.type | ViewType | The type of the view.Values: VIEW_TYPE_SHOW_OBJECTS (0), VIEW_TYPE_FILTER_ONLY (1). |
reverse.name | string | The name of the view. |
reverse.is_common | bool | Tells if the view is admin-defined (common) or user-defined. |
reverse.is_visible | bool | Tells if the view is visible. |
reverse.location | ViewLocation | The location of the view. Valid only if bHasParent is true. |
reverse.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. |
reverse.location.customizes_property_folder | bool | True if the view is overlapping with a property folder. |
reverse.location.customized_property_folder | TypedValue | The overlapped property folder. Ignored if bOverlapping is false. |
reverse.content_definition | SearchDef | The search definition that contains the view levels and search conditions of the view. |
reverse.content_definition.filter_conditions[] | repeated SearchCondition | The conditions that limit the object set of this search. |
reverse.content_definition.grouping_levels[] | repeated GroupingLevel | View levels (the display hierarchy of this search). |
reverse.content_definition.options | SearchFlags | Search flags. This affects the resulting object version set and also distinct view level values displayed inside this search. |
reverse.acl | AccessControlList | Permissions. |
reverse.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. |
reverse.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. |
reverse.acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
reverse.acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
reverse.acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
reverse.acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
reverse.flags_obsolete | uint32 | Bit flags that provide additional information on the view. |
reverse.options | VIEWFLAGS | Bit flags that provide additional information on the view. |
reverse.options.all | bool | Specifies all flags set; Including any future flags. |
reverse.options.indexed | bool | Materialized/indexed view. |
reverse.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. |
reverse.options.sort_across_all_pages_disabled | bool | Sorting search results is disabled. |
reverse.guid | string | GUID for the view. |
reverse.view_visualization | ViewVisualization | View visualization information. |
reverse.view_visualization.subview_groups[] | repeated SubviewGroup | The subviews of the view as groups. |
Related methods
- IRPCViews.AddNewView -- Creates a new private or common view.