Objects, versions, properties and files (IRPCObjectOperations)

View as Markdown

An interface for handling documents and files

Provides methods for adding, modifying and removing objects. Includes version control operations as well, such as checkout and check-in.

Overview

Everything you do with individual objects: read their versions, properties and files, create them, change them, and manage their lifecycle. To find objects in the first place, use SearchObjects.

The other methods are batch variants of the ones above (...Multiple), history and version comments, duplicate detection (Find...Duplicates), objects from external repositories (...External..., ...Promote..., ...Unmanaged...), and helpers for M-Files client features such as document comparison and external editing.

Versions. Most read methods take an ObjVer and need a specific version (OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version). GetProperties, GetPropertiesOfMultipleObjects, GetObjectFiles, GetRelationshipsForObject and GetLatestVersionCommentOfMultipleObjects answer "Not found." to the OBJ_VER_VERSION_TYPE_LATEST marker. To read the latest version, either use a method that has its own "latest" switch (GetObjectVersionAndPropertiesOfMultipleObjects, GetObjectInfoAndProperties, GetObjectDataOfMultipleObjects, GetObjectInfo), or resolve the number first with GetLatestObjectVersion. The same applies to files: FileVer must name a specific file version.

Checked-out objects. "Latest" means the latest checked-in version. A version that is checked out is returned only to the user who has it checked out, and only where the request says so (allow_checked_out, OBJECT_VERSION_DATA_REQUEST_VERSION_TYPE_LATEST_VERSIONS), except GetObjectInfo, which always returns it to that user.

Creating objects: always set acl. AddObjectWithFiles, AddObject and the other creating methods store the ACL you send; they do not compute one from the class. An unset acl gives the new object an empty ACL: once it is checked in, only users with the vault-level right to see all objects can see it, not even its creator. Send a named ACL, for example acl { custom_component { has_named_acl: true named_acl_id: -1 } } ("Full control for all internal users"); see AddObjectWithFiles.

Files. The object's version information (ObjectVersion files) already lists its files with their file_ver, size and MD5 checksum, so after reading an object you can download its files without calling GetObjectFiles. DownloadFile, DownloadFileWithDownloadID, DownloadFileWithDownloadKey, GetFileDownloadUrl and GetFileDownloadUrl2 serve the HTTP gateway and answer "Not implemented." over native gRPC.

Errors. Errors arrive with gRPC status UNKNOWN and the M-Files error message as the status details. A missing object or version is "Not found." (0x8004000B). An object the caller is not allowed to read is "Access denied." (0x800407E4) for most methods, but "Not found." for GetObjectInfoAndProperties, and GetObjectHistory returns an empty list for it.

Background: Objects and versions, Properties and values, Permissions, Workflows and Files.

Highlighted methods

Other methods