IRPCObjectOperations.GetExternalEditingDetails
Vault API / core read session or assertion idempotent
Gets the information a client needs to open a file in an external editing system (SharePoint Embedded).
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetExternalEditingDetails |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-external-editing-details |
| Request | GetExternalEditingDetailsRequest |
| Response | GetExternalEditingDetailsResponse |
| Book and level | Vault API, core |
| Kind | read |
| 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) |
Remarks
Used by M-Files clients with SharePoint Embedded storage.
Request: GetExternalEditingDetailsRequest
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 whose file's authoring details you want. |
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 whose authoring details you want. |
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. |
Response: GetExternalEditingDetailsResponse
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" |
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. |
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. |
has_unversioned_changes | bool | Indicates if the external file has changes which are not versioned in M-Files. |
last_modified_of_latest_change | string | The last modified timestamp of the latest external version. |