API reference

View as Markdown

Services

ServiceBook and levelMethodsSummary
Server version IRPCQueryVersionVault API, core2An interface for querying server version information.
Login and sessions IRPCLoginVault API, core25An interface for handling client login & logout operations.
Vaults on a server IRPCVaultsVault API, core3An interface for enumerating vaults.
Vault information IRPCVaultVault API, core26An interface for vault-level information and operations.
Object types IRPCObjectTypesVault API, core3An interface for reading object types.
Property definitions and classes IRPCPropertyDefsVault API, core4An interface for retrieving property definitions.
Value lists IRPCValueListsVault API, core17Reads value lists and their items, and lets users add and edit value list items and traditional folders.
Search IRPCSearchVault API, core14An interface for performing searches.
Objects, versions, properties and files IRPCObjectOperationsVault API, core132An interface for handling documents and files
Stateless file upload sessions IRPCFileTransferVault API, standard3Stateless file upload. No method requires a sticky session.
Streaming file upload IRPCFileTransferStreamingVault API, standard2File transfer methods that stream the file data.
Views IRPCViewsVault API, standard14Reads and maintains the views of the vault: the common views and the calling user's own (private) views.
Server push IRPCServerDataPushVault API, standard2A server-to-client channel: the server pushes requests and notifications to a logged-in client over a long-lived stream.
Notification rules IRPCNotificationRulesVault API, standard4Manages notification rules: which events on which objects send the user a notification.
Shared links IRPCSharedLinksVault API, standard15Creates and manages shared links to files for people outside the vault.
Shared links (anonymous access) IRPCSharedLinksPublicVault API, standard7Opens and downloads files through shared links, without logging in.
Events and notifications IRPCEventsVault API, standard7Reads and sets the user's notification switch, checks whether a user can receive notifications, and sends requests and custom notifications to users.
Event log IRPCEventLogVault API, standard1Writes custom entries to the vault's event log.
Thumbnails IRPCThumbnailsVault API, standard2Gets thumbnail images of document files and the vault's thumbnail settings.
Languages IRPCLanguagesVault API, standard2Lists the vault's metadata languages and changes the calling user's vault language.
Named access control lists IRPCNamedACLsVault API, standard1Lists the named access control lists that the calling user can see.
Named value storage IRPCNamedValueStorageVault API, standard3Reads and writes named values: small key-value settings stored in the vault, grouped by storage type and namespace.
Workspaces IRPCWorkspaceVault API, standard3Workspace tabs: the views of related objects shown for an object of a given type.
Task pane configurations IRPCTaskPaneConfigurationsVault API, standard4Stores the task pane configuration of M-Files Desktop per user and for all users.
Folder UI settings IRPCFolderUISettingsVault API, standard7Stores the display settings of folders per user and as common defaults.
Substitute users IRPCSubstituteUsersVault API, standard4Reads and sets the substitute users of users.
Electronic signatures IRPCElectronicSignaturesVault API, standard2An interface for working with electronic signatures.
Sensitivity labels IRPCSensitivityLabelsVault API, standard1Reads the Microsoft Purview sensitivity labels of files.
Exported data sets IRPCExportedDataSetsVault API, standard7Reads the exported data sets of the vault and reports their export status (M-Files Reporting).
Data export IRPCDataExportVault API, standard5Reads objects, value list items and property value history in bulk, in batches ordered by ID, for exporting vault data to another system.
Scanning and OCR IRPCScanningAndOCRVault API, standard8Runs server-side OCR: converts files to searchable PDF and recognizes text in page areas.
Vault extension methods IRPCVaultExtensionMethodsVault API, standard5Calls vault extension methods: server-side code in the vault that takes a string and returns a string.
Client scripts and UI extension applications IRPCClientScriptVault API, standard16Lists, installs, enables, disables, licenses and removes the applications of the vault: vault applications (server side) and UI extension applications (client side), and downloads their packages and files.
Conversations IRPCConversationOperationsVault API, standard6Stores conversations with Aino and their chat turns in the vault, per user.
Aino agents IRPCAgentVault API, standard3Connects M-Files clients to the Aino agents of M-Files Cloud.
Anonymous login IRPCAnonymousLoginOperationsVault API, standard2An interface for managing anonymous authentication operations.
Identities IRPCIdentityOperationsVault API, standard1Lets M-Files cloud services that hand out object and value list item IDs on behalf of a vault ask the vault to replenish their ID ranges.
Extension authentications IRPCExtensionAuthenticationsVault API, standard8Manages the credentials that the vault uses to access external systems, such as external repositories connected to the vault, on behalf of the user.
Connection and health checks IRPCTestVault API, standard9An interface for testing connection between a client and the server.
Server administration IRPCServerAdminAdministration API, specialized21Server-wide administration: master database backup and restore, vault backups, server activity, gRPC endpoint certificates, notification (e-mail) settings, server users and the M-Files Manage subscription.
Vault management IRPCVaultsAdminAdministration API, specialized23Creates, attaches, detaches, destroys, upgrades, backs up, restores and copies the vaults of a server, and takes them offline and online.
Vault management (basic) IRPCVaultsAdminBasicAdministration API, specialized7Lists the vaults, replica vaults and Ground Link proxy vaults of the server with their administrative details, as far as the caller is allowed to see them.
Vault administration IRPCVaultAdminAdministration API, specialized21Administers the vault of the session: verify and repair, search indexes, archiving and restoring from archives, and vault-level authentication settings.
Server login accounts IRPCLoginsAdminAdministration API, specialized19Manages the server's login accounts: list, add, modify and remove logins, force logouts, look up Windows accounts and groups, and handle password resets.
Vault login accounts IRPCVaultLoginsAdminAdministration API, specialized17Manages vault login accounts: login accounts stored in one vault, used on servers that have vault login accounts enabled, such as M-Files Cloud.
Users IRPCUsersAdminAdministration API, specialized11Adds, reads, modifies and removes the user accounts of a vault: who may use the vault, with which vault roles.
User groups IRPCUserGroupsAdminAdministration API, specialized12Adds, reads, modifies and removes the user groups of a vault and their members.
Object type administration IRPCObjectTypesAdminAdministration API, specialized18Administers object types and value lists: reads their full definitions, adds, modifies, converts and removes them, and manages value list items with administrator rights.
Property definition and class administration IRPCPropertyDefsAdminAdministration API, specialized14Administers property definitions and classes: reads their full definitions, adds, modifies and removes them, and starts recalculation of automatic values.
Class groups IRPCDocClassGroupsAdminAdministration API, specialized4Administers class groups: reads, adds, modifies and removes the groups that organize document classes.
Workflow administration IRPCWorkflowsAdminAdministration API, specialized5Administers workflows: reads their full definitions with states and transitions, and adds, modifies and removes them.
Common views administration IRPCViewsAdminAdministration API, specialized1Reads the common views and every user's private views of a vault, for administrators.
Named access control list administration IRPCNamedACLsAdminAdministration API, specialized5Adds, reads, modifies and removes the named access control lists (permission templates) of a vault.
Language administration IRPCLanguagesAdminAdministration API, specialized5Adds, modifies and removes the languages of a vault, and reads and writes the translations of its metadata structure names.
Event handlers IRPCEventHandlersAdminAdministration API, specialized4Reads and replaces the event handlers of a vault or of the server: VBScript code that the server runs when an event occurs.
Event administration IRPCEventsAdminAdministration API, specialized13Reads, exports and deletes the vault's event log, turns event logging on or off, and stores the caller's saved event log filters.
Scheduled jobs IRPCScheduledJobsAdminAdministration API, specialized10Lists, adds, changes, removes, starts and cancels scheduled jobs of the server or of a vault.
Background operations IRPCBackgroundOperationsAdminAdministration API, specialized9Monitors the vault's background work: refreshes of external object types and external locations, and the queue of asynchronous tasks.
Exported data set administration IRPCExportedDataSetsAdminAdministration API, specialized9Manages the vault's exported data sets: the definitions of the vault data that M-Files Reporting Data Services exports to a reporting database.
External locations IRPCExternalLocationsAdminAdministration API, specialized6Administers the vault's external sources: file folders and mail boxes from which the server imports or links content.
Thumbnail administration IRPCThumbnailsAdminAdministration API, specialized1Discards the thumbnail images stored in a vault.
Web access administration IRPCWebAccessAdminAdministration API, specialized7Sets up M-Files Web in Internet Information Services (IIS) on the server computer.
License management IRPCLicenseManagementAdministration API, specialized6Reads and sets the server's license, its usage, and whether licensed features such as OCR or M-Files Web are available.
Monitoring status IRPCMonitoringStatusAdministration API, specialized3Reads the vault's monitoring indicators; currently the status of the search indexes.
Declarative metadata structure IRPCDeclarativeMetadataStructureAdministration API, specialized8Reads and validates the whole metadata structure of a vault as one declarative JSON document. Preview feature, off by default.
Declarative metadata structure (protobuf) IRPCDeclarativeMetadataStructureAsProtobufAdministration API, specialized4Reads and replaces the whole metadata structure of a vault as one typed message. Preview feature, off by default; for the declarative configuration converter.
Cloud management IRPCCloudManagementApiOperationsAdministration API, specialized1Gets the identity of the server in M-Files Manage, for client features that call M-Files cloud services.
Indexing data source IRPCIndexingDataSourceServer integration API, specialized21An interface for retrieving data for indexing.
Indexing data source (version 2) IRPCIndexingDataSource2Server integration API, specialized5More methods for search indexers, continuing IRPCIndexingDataSource.
Monitoring data points IRPCMonitoringDatapointsSinkServer integration API, specialized4Receives the progress and status data points that the M-Files indexing service reports about each index of the vault.
Application task queue IRPCApplicationTaskQueueServer integration API, specialized12Persistent task queues and broadcast messages that vault applications use to share background work between the server instances of a vault.
Replication packages IRPCReplicationPackagesServer integration API, specialized2Lists and deletes the content replication packages that wait in cloud storage for import into the vault.
WOPI operations IRPCWOPIOperationsServer integration API, specialized3Creates the access tokens with which Office for the web (WOPI) opens vault files, and returns the Office for the web actions that the vault can use.
WOPI operations (anonymous) IRPCWOPIOperationsPublicServer integration API, specialized15File, lock and session operations for Office for the web (WOPI), authorized by a WOPI access token instead of an M-Files session.
Web companion IRPCWebCompanionOperationServer integration API, specialized1Registers an M-Files Web Companion installation with a vault.
Web companion tasks IRPCWebCompanionTaskOperationServer integration API, specialized2Passes "open this file in a desktop application" tasks from M-Files Web to M-Files Web Companion.
Document file I/O for server components IRPCDocumentOperationsFileIOInternalServer integration API, specialized2Server-to-server variants of file upload commit and file size checks.
Ground Link channel IRPCGroundLinkServer integration API, specialized1The M-Files Ground Link channel: a long-lived two-way stream between a Ground Link proxy and the M-Files Server that hosts the vault, typically in M-Files Cloud.