IRPCObjectOperations.GetLatestObjectVersion
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the number and GUID of the latest version of an object.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetLatestObjectVersion |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-latest-object-version |
| Request | GetLatestObjectVersionRequest |
| Response | GetLatestObjectVersionResponse |
| 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
The cheapest way to turn an object ID into a specific version for the methods that do not accept
the latest-version marker. The returned version is OBJ_VER_VERSION_TYPE_SPECIFIC. A caller who
cannot read the object gets "Access denied." (0x800407E4).
Request: GetLatestObjectVersionRequest
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_id | ObjID | The object ID. |
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_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_id.item_id.internal_id | int32 | The ID of the object or value list item. |
obj_id.item_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
allow_checked_out | bool | True to get the checked-out version when the object is checked out to the caller. Otherwise, and for objects checked out to another user, the latest checked-in version. |
Response: GetLatestObjectVersionResponse
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 |
|---|---|---|
object_version | ObjVerVersion | The latest version, as a specific version. |
object_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). |
object_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. |
object_version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
object_version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
version_guid | string | The GUID of that version. |