IRPCViews.GetMultipleViews
Vault API / standard read session or assertion idempotent returns metadata structure version
Gets several views of external repositories in one call.
| Service | Views MFiles.IRPCViews |
|---|---|
| gRPC method | /MFiles.IRPCViews/GetMultipleViews |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-multiple-views |
| Request | GetMultipleViewsRequest |
| Response | GetMultipleViewsResponse |
| Book and level | Vault API, standard |
| 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) |
Remarks
- Only for external repository views: every ID must have
external_repository_idset. A vault view ID fails the call with "The parameter is incorrect."; read vault views with GetView or GetViews. - The views are requested from the external repository connections of the vault.
Request: GetMultipleViewsRequest
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 |
|---|---|---|
utf8szviewids[] | repeated ItemID | The IDs of the external views, each with external_repository_id set. |
utf8szviewids[].internal_id | int32 | The ID of the object or value list item. |
utf8szviewids[].external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
utf8szviewids[].external_repository_id.connection | string | The external repository connection identifier. |
utf8szviewids[].external_repository_id.item | string | External ID within the scope of the connection to external system. |
required | FOLDERDATAREQUESTFLAGS | The folder information that must be returned. |
required.all | bool | Specifies all flags set; Including any future flags. |
required.folder_info | bool | Folder information is requested, e.g. View or ExternalView. |
required.location | bool | The exact location of the folder is requested, e.g. ViewLocation or FolderArray. |
required.acl | bool | The acl of the folder is requested. |
accepted | FOLDERDATAREQUESTFLAGS | Additional folder information the caller can accept. |
accepted.all | bool | Specifies all flags set; Including any future flags. |
accepted.folder_info | bool | Folder information is requested, e.g. View or ExternalView. |
accepted.location | bool | The exact location of the folder is requested, e.g. ViewLocation or FolderArray. |
accepted.acl | bool | The acl of the folder is requested. |
Response: GetMultipleViewsResponse
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 |
|---|---|---|
putf8szviews[] | repeated FolderData | The views as FolderData. |
putf8szviews[].type | FolderType | The type of the folder (eg. eftViewFolder).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). |
putf8szviews[].data | FolderDataUnion | Additional folder type -specific data as a union. |
putf8szviews[].data.view_folder | FolderDataUnion.ViewFolderData (oneof data) | |
putf8szviews[].data.external_view_folder | FolderDataUnion.ExternalViewFolderData (oneof data) | |
putf8szviews[].folder_location | FolderArray | Array of folders describing the exact location of the folder. If null, the caller must resolve the location by walking the parent chain. |
putf8szviews[].folder_location.value[] | repeated Folder | Array of Folder structures. |
putf8szviews[].folder_location_name | string | The display name of the folder location. Describes the location (e.g. full path) rather than the actual name. Specified only if the location data is specified, too. |