IRPCObjectOperations.RelayMasterStorageOperations
Vault API / core write session or assertion idempotent
Relays file or object operations to Master Storage. Internal to M-Files; not for applications.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/RelayMasterStorageOperations |
| HTTP (mf-http-grpc) | POST /grpc/v1/relay-master-storage-operations |
| Request | RelayMasterStorageOperationsRequest |
| Response | RelayMasterStorageOperationsResponse |
| Book and level | Vault API, core |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Request: RelayMasterStorageOperationsRequest
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 |
|---|---|---|
obj_ver | ObjVer | The object which is relayed to Master Storage. |
obj_ver.obj_id | ObjID | The object. |
obj_ver.obj_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_ver.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
obj_ver.version.type | ObjVerVersionType | What internal_version means. OBJ_VER_VERSION_TYPE_SPECIFIC for a version number.Values: OBJ_VER_VERSION_TYPE_UNINITIALIZED (0), OBJ_VER_VERSION_TYPE_LATEST (1), OBJ_VER_VERSION_TYPE_ANY (2), OBJ_VER_VERSION_TYPE_ALL (3), OBJ_VER_VERSION_TYPE_SPECIFIC (4), OBJ_VER_VERSION_TYPE_VALUE_LIST_ITEM (6), OBJ_VER_VERSION_TYPE_OBJECT_LEVEL_REFERENCE (7). |
obj_ver.version.internal_version | int32 | The version number, starting from 1, when type is OBJ_VER_VERSION_TYPE_SPECIFIC. The server returns -1 with OBJ_VER_VERSION_TYPE_LATEST. |
obj_ver.version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
obj_ver.version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
file_ver | FileVer | The file version which is relayed to Master Storage. |
file_ver.file_id | FileID | The file. |
file_ver.file_id.type | FileIDType | FILE_IDTYPE_SPECIFIC for one file.Values: FILE_IDTYPE_UNINITIALIZED (0), FILE_IDTYPE_ALL (1), FILE_IDTYPE_ANY (2), FILE_IDTYPE_SPECIFIC (3). |
file_ver.file_id.internal_id | int32 | The file ID. |
file_ver.file_id.external_repository_id | string | Used only for files in external repositories. Leave empty. |
file_ver.type | FileVerType | FILE_VER_TYPE_SPECIFIC for a file version number.Values: FILE_VER_TYPE_UNINITIALIZED (0), FILE_VER_TYPE_LATEST (1), FILE_VER_TYPE_ANY (2), FILE_VER_TYPE_SPECIFIC (3). |
file_ver.internal_version | int32 | The file version number. |
file_ver.external_repository_version | string | Used only for files in external repositories. Leave empty. |
file_ver.external_repository_sort_key | int64 | Used only for files in external repositories. Leave 0. |
get_external_editing_details | bool | If true, returns information required for starting a co-authoring session to the client. |
get_external_preview_details | bool | If true, returns information required for previewing document having co-authoring capabilities to the client. |
get_external_version_data | bool | If true, returns information like version id, last modified datetime and file size related to external version. |
get_labels | bool | If true, returns labels (e.g. sensitivity / retention) attached to the file in Master Storage. |
Response: RelayMasterStorageOperationsResponse
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 |
|---|---|---|
external_type | string | Specifies the system used to edit the file. Opaque to the server, tells the client how the data can be used. eg. "SharePointEmbedded". Populated when request has getExternalEditingDetails or getExternalPreviewDetails flag set to true. |
external_data | string | Data the client can use to open the document. Interpretation depends on externalType. eg. in SharePointEmbedded this is the url of the document. Populated when request has getExternalEditingDetails flag set to true. |
external_preview_data | string | Data the client can use to preview the document. Interpretation depends on externalType. eg. in SharePointEmbedded this is the preview url of the document. Populated when request has getExternalPreviewDetails flag set to true. |
has_unversioned_changes | bool | Indicates if the external file has changes which are not versioned in M-Files. Populated when request has getExternalVersionData set to true. |
last_modified_of_latest_change | string | The last modified timestamp of the latest external version. Populated when request has getExternalVersionData set to true. |
labels | string | Labels attached to the file in Master Storage. The server is opaque to the contents, but in practice the format is the SPE FileSensitivityLabelInfo shape -- the dedicated GetSensitivityLabels path parses the same payload into that struct, so callers should assume the SPE shape rather than genuine free-form. Populated when request has getLabels flag set to true. |