IRPCVaults.GetGroundLinkProxies
Vault API / core read session idempotent
Lists the Ground Link proxy vaults on the server that the session's user can see.
| Service | Vaults on a server MFiles.IRPCVaults |
|---|---|
| gRPC method | /MFiles.IRPCVaults/GetGroundLinkProxies |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-ground-link-proxies |
| Request | GetGroundLinkProxiesRequest |
| Response | GetGroundLinkProxiesResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Used by M-Files components that work with Ground Link; applications rarely need it. Visibility
and online_states work as in GetVaults. The response is
empty on a server without Ground Link proxies.
Request: GetGroundLinkProxiesRequest
A structure that specifies get ground link proxies request.
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 |
|---|---|---|
include_offline_vaults | bool | True to also return proxies that are offline. |
Response: GetGroundLinkProxiesResponse
A structure that specifies get ground link proxies response.
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 |
|---|---|---|
vaults[] | repeated VaultBasic | The visible Ground Link proxy vaults. |
vaults[].guid | string | The vault GUID, in braces and upper case. Use it as LoginData.vault_guid. |
vaults[].display_name | string | The vault name shown to users. |
vaults[].tooltip | string | Optional description. Often empty. |
vaults[].icon | bytes | The vault icon in .ico format, or empty. |
vaults[].dns_names | StringArray | Host names configured for the vault, if any. |
vaults[].dns_names.value[] | repeated string | String values. |
online_states[] | repeated bool | True if the proxy at the same index in vaults is online. |
Related methods
- GetVaults -- Lists the vaults on the server that the session's user can see.