IRPCSharedLinksPublic.GetWOPIFileInfo
Vault API / standard write no session
Gets information about the file of a link for Office for the web (WOPI) operations. Used by M-Files clients; applications rarely call it.
| Service | Shared links (anonymous access) MFiles.IRPCSharedLinksPublic |
|---|---|
| gRPC method | /MFiles.IRPCSharedLinksPublic/GetWOPIFileInfo |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-wopifile-info |
| Request | GetWOPIFileInfoRequest |
| Response | GetWOPIFileInfoResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Request: GetWOPIFileInfoRequest
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 |
|---|---|---|
vault | string | The vault GUID. |
access_key | string | The access key of the link. |
Response: GetWOPIFileInfoResponse
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 |
|---|---|---|
result | WOPIFileInfo | The file's title, extension, size, the account name of the link's creator, and the object and file version. |
result.title | string | The title of the file. |
result.extension | string | File extension, not including the dot (e.g. "doc"). |
result.created_by_user | string | The creator of this shared Link. |
result.logical_size | int64 | The logical size of the file in bytes. |
result.change_time | google.protobuf.Timestamp | The time in UTC the file was last written to or its attributes were changed. |
result.obj_ver | ObjVer | The object version referenced by the shared link. |
result.obj_ver.obj_id | ObjID | The object. |
result.obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
result.file_ver | FileVer | The file version referenced by the shared link. |
result.file_ver.file_id | FileID | The file. |
result.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). |
result.file_ver.internal_version | int32 | The file version number. |
result.file_ver.external_repository_version | string | Used only for files in external repositories. Leave empty. |
result.file_ver.external_repository_sort_key | int64 | Used only for files in external repositories. Leave 0. |