Overview

M-Files Web Service consists of several resources and the types that represent these. Most of the resource belong to one of the five major resource hierarchies. These hierarchies are listed below.

The objects hierarchy contains the resources used to read and edit individual objects. This includes searching objects, reading and editing metadata, downloading files and creating new objects.

The views hierarchy contains the resources representing the document vault view hierarchy. These resources enable applications to navigate through M-Files views. These resources are read-only as M-Files Web Service doesn’t currently support creating or modifying views.

The vault structure hierarchy provides information on the metadata structure of the vault. The hierarchy contains resources for object types, property definitions and workflows for example. Similar to the views hierarchy, the structure hierarchy doesn’t currently support modification either.

The server hierarchy contains the resources representing the server-state. The resources in this hierarchy are also accessible without a document vault level authentication. Some, such as /server/authenticationtokens, can even be accessed without any authentication at all.

The session hierarchy contains information on the current session. This hierarchy is required for Cookie-based authentication as it provides the /session and /session/vault resources.