IRPCSearch.SearchViewLevelFolders

Vault API / core read session or assertion idempotent returns metadata structure version

The search covers the folders that the listing of the level would show without the folder limit. The results can be saved as part of the user's folder selection. Fails with E_NOTIMPL when the feature is not enabled on the server.

Service	Search `MFiles.IRPCSearch`
gRPC method	`/MFiles.IRPCSearch/SearchViewLevelFolders`
HTTP (mf-http-grpc)	`POST /grpc/v1/search-view-level-folders`
Request	`SearchViewLevelFoldersRequest`
Response	`SearchViewLevelFoldersResponse`
Book and level	Vault API, core
Kind	read
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)

Request: SearchViewLevelFoldersRequest

Searches the folders of one view level by name. The search covers every folder that the listing of the level would show without the folder limit, including the folders beyond it.

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
`folder_location[]`	repeated `Folder`	The folder location, from the vault root to the parent of the level whose folders are searched. The same path that the listing of the level uses.
`folder_location[].type`	`FolderType`	The type of the folder, for example `FOLDER_TYPE_VIEW_FOLDER` or `FOLDER_TYPE_PROPERTY_FOLDER`.Values: `FOLDER_TYPE_UNKNOWN` (0), `FOLDER_TYPE_ANY_FOLDER` (1), `FOLDER_TYPE_VIEW_FOLDER` (2), `FOLDER_TYPE_PROPERTY_FOLDER` (3), `FOLDER_TYPE_TRADITIONAL_FOLDER` (4), `FOLDER_TYPE_SEARCH_FOLDER` (5), `FOLDER_TYPE_EXTERNAL_VIEW_FOLDER` (6).
`folder_location[].data`	`FolderInfoUnion`	Additional folder type -specific information as a union.
`folder_location[].data.any_folder`	`FolderInfoUnion.AnyFolderData` (oneof data)	Any folder type.
`folder_location[].data.view_folder`	`FolderInfoUnion.ViewFolderData` (oneof data)	View folder type.
`folder_location[].data.property_folder`	`FolderInfoUnion.PropertyFolderData` (oneof data)	Property (virtual) folder type.
`folder_location[].data.traditional_folder`	`FolderInfoUnion.TraditionalFolderData` (oneof data)	Traditional folder type.
`folder_location[].data.search_folder`	`FolderInfoUnion.SearchFolderData` (oneof data)	Search folder (extended view folder) type.
`folder_location[].data.external_view_folder`	`FolderInfoUnion.ExternalViewFolderData` (oneof data)	External view folder type.
`search_text`	`string`	The text that the folder names must contain, ignoring letter case. At most 100 characters. Empty matches every folder.
`limit`	`uint32`	The maximum number of results. Zero means 100. The value is clamped to 1-500.

Response: SearchViewLevelFoldersResponse

A structure that specifies the response type for the SearchViewLevelFolders method.

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
`results[]`	repeated `ViewLevelFolderSearchResult`	The matching folders, at most the requested limit, sorted by name ignoring case and diacritics, with numbers in numeric order.
`results[].folder`	`TypedValue`	The folder, in the same form as the property folders of the level's listing. It can be saved as part of a folder selection as it is.
`results[].folder.is_null_value`	`bool`	True if the value is empty. `data` is then unset.
`results[].folder.type`	`Datatype`	The data type of the value.
`results[].folder.data`	`TypedValueUnion`	The value, in the member that matches `type`. Unset for an empty value.
`results[].is_selected`	`bool`	True when the folder is in the user's folder selection for the location.
`has_more_results`	`bool`	True when more folders match than were returned, or when the level has more folders than the search goes through. Narrowing the search text does not reveal the folders beyond that cap.