IRPCObjectOperations.GetLatestFileVersion
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the latest version of a file and the object version it belongs to.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetLatestFileVersion |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-latest-file-version |
| Request | GetLatestFileVersionRequest |
| Response | GetLatestFileVersionResponse |
| 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 | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Use the returned pobjver and file_version to build an ObjFileVer for downloading.
Request: GetLatestFileVersionRequest
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 |
|---|---|---|
file_id | FileID | The file, as File.file_ver.file_id. |
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_id.internal_id | int32 | The file ID. |
file_id.external_repository_id | string | Used only for files in external repositories. Leave empty. |
allow_checked_out | bool | True to get the file version of the checked-out version when the object is checked out to the caller. |
Response: GetLatestFileVersionResponse
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 |
|---|---|---|
file_version | int32 | The latest file version number. |
pobjver | ObjVer | The specific object version that contains that file version. |
pobjver.obj_id | ObjID | The object. |
pobjver.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). |
pobjver.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
pobjver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
pobjver.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). |
pobjver.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. |
pobjver.version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
pobjver.version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |