IRPCObjectOperations.AddVersionTag
Vault API / core write session or assertion idempotent returns metadata structure version
Adds the specified tag to the document version. If the tag already exists in the specified target version, this method does nothing. Other tags are not affected.
Optionally, this method can clear the specified tag from the other versions of the target document.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/AddVersionTag |
| HTTP (mf-http-grpc) | POST /grpc/v1/add-version-tag |
| Request | AddVersionTagRequest |
| Response | AddVersionTagResponse |
| Book and level | Vault API, core |
| Kind | write |
| 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) |
Request: AddVersionTagRequest
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. |
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. |
tag | int32 | The ID of the version tag to add. |
clear_this_tag_from_other_versions | bool | If true, this tag is cleared from the other versions of this document if it exists in them. |
Response: AddVersionTagResponse
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 |
|---|---|---|
modified_object | ObjectVersionEx | Information of the modified document version after the operation. |
modified_object.version_info | ObjectVersion | Object Version information. |
modified_object.version_info.version | ObjVerVersion | The version number, as a specific version. |
modified_object.version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
modified_object.version_info.title | string | The title (name) of the object in this version. |
modified_object.version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
modified_object.version_info.has_relationships_from_this | bool | Note: this field is deprecated. True if relationships from this object version to one or more documents exist. |
modified_object.version_info.has_relationships_to_this | bool | Note: this field is deprecated. True if relationships from one or more documents to this object version exist. |
modified_object.version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
modified_object.version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
modified_object.version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
modified_object.version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
modified_object.version_info.class_id | int32 | The class ID of the version. |
modified_object.version_info.version_guid | string | The GUID of this version. |
modified_object.version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
modified_object.version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
modified_object.object_info | ObjectLevelInfo | Object-level information. |
modified_object.object_info.obj_id | ObjID | The object type and ID of the object. |
modified_object.object_info.external_id_status | ExtIDStatus | The status of this object's external ID.Values: EXT_IDSTATUS_UNKNOWN (0), EXT_IDSTATUS_EXTERNAL (1), EXT_IDSTATUS_INTERNAL (2), EXT_IDSTATUS_DISCARDED (3), EXT_IDSTATUS_NOT_AVAILABLE (4), EXT_IDSTATUS_EXTERNAL_REDUCED (5). |
modified_object.object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
modified_object.object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
modified_object.object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
modified_object.object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
modified_object.object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
modified_object.object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
modified_object.object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
modified_object.object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
modified_object.object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
modified_object.object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
modified_object.object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
modified_object.object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
modified_object.object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
modified_object.object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
modified_object.object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
modified_object.object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
modified_object.object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |
modified_properties[] | repeated PropertyValue | Receives the property values of the modified document version after the operation. |
modified_properties[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
modified_properties[].value | TypedValue | The value. Its type must match the data type of the property definition. |
modified_properties[].value.is_null_value | bool | True if the value is empty. data is then unset. |
modified_properties[].value.type | Datatype | The data type of the value. |
modified_properties[].value.data | TypedValueUnion | The value, in the member that matches type. Unset for an empty value. |
is_latest_visible | bool | True if the latest version of the document is visible after the operation. |
latest_version | ObjectVersionEx | The latest version of the object after the operation, if is_latest_visible is true. |
latest_version.version_info | ObjectVersion | Object Version information. |
latest_version.version_info.version | ObjVerVersion | The version number, as a specific version. |
latest_version.version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
latest_version.version_info.title | string | The title (name) of the object in this version. |
latest_version.version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
latest_version.version_info.has_relationships_from_this | bool | Note: this field is deprecated. True if relationships from this object version to one or more documents exist. |
latest_version.version_info.has_relationships_to_this | bool | Note: this field is deprecated. True if relationships from one or more documents to this object version exist. |
latest_version.version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
latest_version.version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
latest_version.version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
latest_version.version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
latest_version.version_info.class_id | int32 | The class ID of the version. |
latest_version.version_info.version_guid | string | The GUID of this version. |
latest_version.version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
latest_version.version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
latest_version.object_info | ObjectLevelInfo | Object-level information. |
latest_version.object_info.obj_id | ObjID | The object type and ID of the object. |
latest_version.object_info.external_id_status | ExtIDStatus | The status of this object's external ID.Values: EXT_IDSTATUS_UNKNOWN (0), EXT_IDSTATUS_EXTERNAL (1), EXT_IDSTATUS_INTERNAL (2), EXT_IDSTATUS_DISCARDED (3), EXT_IDSTATUS_NOT_AVAILABLE (4), EXT_IDSTATUS_EXTERNAL_REDUCED (5). |
latest_version.object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
latest_version.object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
latest_version.object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
latest_version.object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
latest_version.object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
latest_version.object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
latest_version.object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
latest_version.object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
latest_version.object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
latest_version.object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
latest_version.object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
latest_version.object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
latest_version.object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
latest_version.object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
latest_version.object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
latest_version.object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
latest_version.object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |
updated_objects[] | repeated ObjectVersionEx | Information about objects that were also updated during the operation. (represented by ObjectVersionEx structs.) |
updated_objects[].version_info | ObjectVersion | Object Version information. |
updated_objects[].version_info.version | ObjVerVersion | The version number, as a specific version. |
updated_objects[].version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
updated_objects[].version_info.title | string | The title (name) of the object in this version. |
updated_objects[].version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
updated_objects[].version_info.has_relationships_from_this | bool | Note: this field is deprecated. True if relationships from this object version to one or more documents exist. |
updated_objects[].version_info.has_relationships_to_this | bool | Note: this field is deprecated. True if relationships from one or more documents to this object version exist. |
updated_objects[].version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
updated_objects[].version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
updated_objects[].version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
updated_objects[].version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
updated_objects[].version_info.class_id | int32 | The class ID of the version. |
updated_objects[].version_info.version_guid | string | The GUID of this version. |
updated_objects[].version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
updated_objects[].version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
updated_objects[].object_info | ObjectLevelInfo | Object-level information. |
updated_objects[].object_info.obj_id | ObjID | The object type and ID of the object. |
updated_objects[].object_info.external_id_status | ExtIDStatus | The status of this object's external ID.Values: EXT_IDSTATUS_UNKNOWN (0), EXT_IDSTATUS_EXTERNAL (1), EXT_IDSTATUS_INTERNAL (2), EXT_IDSTATUS_DISCARDED (3), EXT_IDSTATUS_NOT_AVAILABLE (4), EXT_IDSTATUS_EXTERNAL_REDUCED (5). |
updated_objects[].object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
updated_objects[].object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
updated_objects[].object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
updated_objects[].object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
updated_objects[].object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
updated_objects[].object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
updated_objects[].object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
updated_objects[].object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
updated_objects[].object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
updated_objects[].object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
updated_objects[].object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
updated_objects[].object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
updated_objects[].object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
updated_objects[].object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
updated_objects[].object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
updated_objects[].object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
updated_objects[].object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |