IRPCVaultsAdmin.GetDefaultDataFolderPrefix
Administration API / specialized admin session idempotent
Gets the default data folder prefix of new document vaults.
| Service | Vault management MFiles.IRPCVaultsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdmin/GetDefaultDataFolderPrefix |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-default-data-folder-prefix |
| Request | GetDefaultDataFolderPrefixRequest |
| Response | GetDefaultDataFolderPrefixResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| 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
- Requires the system administrator server role (server right
manage_vaults); a vault administrator gets "Access denied". - Read-only. M-Files Admin uses the folder as the starting value of
Vault.main_data_folderfor a new vault (see CreateNewVault).
Request: GetDefaultDataFolderPrefixRequest
No fields.
Response: GetDefaultDataFolderPrefixResponse
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 | string | The default parent folder of the data folders of new vaults on the server, e.g. C:\Program Files\M-Files\Server Vaults\. Always ends with a backslash. |
Related methods
- CreateNewVault -- Creates a new document vault.