IRPCObjectOperations.GetVersionCommentHistory
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the version comments of an object up to a given version, oldest first.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetVersionCommentHistory |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-version-comment-history |
| Request | GetVersionCommentHistoryRequest |
| Response | GetVersionCommentHistoryResponse |
| 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
obj_ver must name a specific version, or have internal_version -1 for the whole history. The
OBJ_VER_VERSION_TYPE_LATEST marker fails with "The parameter is incorrect.".
Request: GetVersionCommentHistoryRequest
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 version for which the version comment history is gathered. The version comment history includes this version and any older versions. If the version part is -1, the version comment history of the whole object is returned. |
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. |
Response: GetVersionCommentHistoryResponse
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 |
|---|---|---|
comments[] | repeated VersionComment | Results in ascending order. |
comments[].obj_ver | ObjVer | Object version. |
comments[].obj_ver.obj_id | ObjID | The object. |
comments[].obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
comments[].property_values[] | repeated PropertyValue | Properties. |
comments[].property_values[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
comments[].property_values[].value | TypedValue | The value. Its type must match the data type of the property definition. |