IRPCObjectOperations.GetObjectInfoAndPropertiesWithMetadata
Vault API / core write session or assertion returns metadata structure version
Like GetObjectInfoAndProperties, but each property value also carries its value metadata.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetObjectInfoAndPropertiesWithMetadata |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-object-info-and-properties-with-metadata |
| Request | GetObjectInfoAndPropertiesWithMetadataRequest |
| Response | GetObjectInfoAndPropertiesWithMetadataResponse |
| 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 | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Takes the same parameters as
GetObjectInfoAndProperties
and behaves the same way. Each returned value also has value_metadata; for values without such
metadata the server returns confidence "-1".
Request: GetObjectInfoAndPropertiesWithMetadataRequest
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. |
latest_version | bool | True to get the latest version. False to get the version specified by lDocVersion. |
allow_checked_out | bool | True if a checked-out document version can be returned if the document is currently checked out to this user. Ignored if bLatestVersion is false. Note that even if this parameter is true, the method never returns a version that is checked out to some other user. |
doc_version | ObjVerVersion | The ID of the DocumentVersion. Ignored if bLatestVersion is true. |
doc_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). |
doc_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. |
doc_version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
doc_version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
Response: GetObjectInfoAndPropertiesWithMetadataResponse
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_info | ObjectVersionEx | Receives the object version data (when found and visible). Note that when requesting the latest version, its ID parts (document ID and version ID) are always returned whenever the latest version exists although it's not visible to the user. |
object_info.version_info | ObjectVersion | Object Version information. |
object_info.version_info.version | ObjVerVersion | The version number, as a specific version. |
object_info.version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
object_info.version_info.title | string | The title (name) of the object in this version. |
object_info.version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
object_info.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. |
object_info.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. |
object_info.version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
object_info.version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
object_info.version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
object_info.version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
object_info.version_info.class_id | int32 | The class ID of the version. |
object_info.version_info.version_guid | string | The GUID of this version. |
object_info.version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
object_info.version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
object_info.object_info | ObjectLevelInfo | Object-level information. |
object_info.object_info.obj_id | ObjID | The object type and ID of the object. |
object_info.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). |
object_info.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. |
object_info.object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
object_info.object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
object_info.object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
object_info.object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
object_info.object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
object_info.object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
object_info.object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
object_info.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. |
object_info.object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
object_info.object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
object_info.object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
object_info.object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
object_info.object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
object_info.object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
object_info.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. |
object_info.object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |
property_array[] | repeated PropertyValueWithMetadata | Receives the object version properties (when found and visible). |
property_array[].property_def | int32 | Property definition ID. |
property_array[].value | TypedValueWithMetadata | The value of the property. |
property_array[].value.type | Datatype | Data type. Note. Name of the property can't be isNull because name collision with Objective-C reserved name. |
property_array[].value.is_null_value | bool | Is the value unset. |
property_array[].value.data | TypedValueUnionWithMetadata | The value data as a union, if set. |
property_array[].value.value_metadata | TypedValueMetadata | The metadata about the typed value. If the value is a Lookup or MSLookup, this data will be in that struct. |
Related methods
- GetObjectInfoAndProperties -- Gets the version information and the property values of one object, either its latest version or a specific version.
- GetObjectInfo -- Gets the version information of one object without its property values.