IRPCObjectOperations.GetObjectHistory
Vault API / core read session or assertion idempotent returns metadata structure version
Lists the existing versions of an object, oldest first.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetObjectHistory |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-object-history |
| Request | GetObjectHistoryRequest |
| Response | GetObjectHistoryResponse |
| 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
Each item is a specific version number. Versions that have been destroyed are not listed, so the numbers can have gaps and the first one need not be 1. The version that is checked out to the caller is included.
A caller who cannot read the object gets an empty list, not an error. A missing object gives "Not found.". For version information per version, use GetObjectHistory2.
Request: GetObjectHistoryRequest
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. |
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. |
Response: GetObjectHistoryResponse
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 |
|---|---|---|
versions[] | repeated ObjVerVersion | The versions, oldest first, as specific versions. |
versions[].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). |
versions[].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. |
versions[].external_repository_version | string | Used only for objects in external repositories. Leave empty. |
versions[].external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
Related methods
- GetObjectHistory2 -- Lists the existing versions of an object with their version information, oldest first.