IRPCDataExport.GetExportedObjectProperties

Vault API / standard read session idempotent

Gets the version information and property values of many objects in one call.

Service	Data export `MFiles.IRPCDataExport`
gRPC method	`/MFiles.IRPCDataExport/GetExportedObjectProperties`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-exported-object-properties`
Request	`GetExportedObjectPropertiesRequest`
Response	`GetExportedObjectPropertiesResponse`
Book and level	Vault API, standard
Kind	read
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

The response has one entry per requested object, in request order, in both object_version_ex and prop_val_arrays.
A version with OBJ_VER_VERSION_TYPE_LATEST reads the latest checked-in version.
An object that does not exist, has no checked-in version, or that the user cannot see gets an empty entry. For a destroyed object, only object_version_ex.object_info.obj_id is set, so you can tell it apart from a hidden one; if Name or title (0) was requested its last name is returned too.
Each object may appear only once: a repeated object fails the call with "Already exists.".

Request: GetExportedObjectPropertiesRequest

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
`exportedobjects[]`	repeated `ObjVer`	The objects to read. Each object at most once.
`exportedobjects[].obj_id`	`ObjID`	The object.
`exportedobjects[].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).
`exportedobjects[].obj_id.item_id`	`ItemID`	The ID of the object within its type, in `item_id.internal_id`.
`exportedobjects[].version`	`ObjVerVersion`	The version. Usually `OBJ_VER_VERSION_TYPE_SPECIFIC` with `internal_version`.
`exportedobjects[].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).
`exportedobjects[].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`.
`exportedobjects[].version.external_repository_version`	`string`	Used only for objects in external repositories. Leave empty.
`exportedobjects[].version.external_repository_sort_key`	`int64`	Used only for objects in external repositories. Leave 0.
`property_defs[]`	repeated `int32`	The IDs of the property definitions to return. Empty returns all properties.

Response: GetExportedObjectPropertiesResponse

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_ex[]`	repeated `ObjectVersionEx`	The version information of each object, in request order. Empty for objects that were not found or not visible.
`object_version_ex[].version_info`	`ObjectVersion`	Object Version information.
`object_version_ex[].version_info.version`	`ObjVerVersion`	The version number, as a specific version.
`object_version_ex[].version_info.display_version`	`string`	The version label to show, if it differs from the version number; empty otherwise.
`object_version_ex[].version_info.title`	`string`	The title (name) of the object in this version.
`object_version_ex[].version_info.is_single_file_object`	`bool`	True if the object is a single-file document, which has exactly one file.
`object_version_ex[].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_version_ex[].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_version_ex[].version_info.has_assignments`	`bool`	True if relationships from one or more assignments to this object version exist.
`object_version_ex[].version_info.last_modified_at_utc`	`google.protobuf.Timestamp`	When the version was last modified, in UTC.
`object_version_ex[].version_info.files[]`	repeated `File`	The files of this version. Each `file_ver` can be passed to `DownloadFile_Begin`.
`object_version_ex[].version_info.object_version_flags`	`OBJVERFLAGS`	Bit flags that provide additional information on the object version.
`object_version_ex[].version_info.class_id`	`int32`	The class ID of the version.
`object_version_ex[].version_info.version_guid`	`string`	The GUID of this version.
`object_version_ex[].version_info.base_properties[]`	repeated `PropertyValue`	Not filled by the object read methods; read the property values with `GetObjectVersionAndPropertiesOfMultipleObjects` or `GetProperties`.
`object_version_ex[].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_version_ex[].object_info`	`ObjectLevelInfo`	Object-level information.
`object_version_ex[].object_info.obj_id`	`ObjID`	The object type and ID of the object.
`object_version_ex[].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_version_ex[].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_version_ex[].object_info.checked_out_version`	`ObjVerVersion`	The version that is checked out. Version number 0 if the object is not checked out.
`object_version_ex[].object_info.checked_out_to_user_id`	`int32`	The ID of the user who has the object checked out.
`object_version_ex[].object_info.checked_out_to_user_name`	`string`	The user name of the user who has the object checked out.
`object_version_ex[].object_info.checked_out_to_host_name`	`string`	The host name of the computer to which the object was checked out.
`object_version_ex[].object_info.checked_out_at_utc`	`google.protobuf.Timestamp`	The timestamp of the moment the object was checked out.
`object_version_ex[].object_info.checked_in_version`	`ObjVerVersion`	The latest checked-in version.
`object_version_ex[].object_info.created_at_utc`	`google.protobuf.Timestamp`	The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue).
`object_version_ex[].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_version_ex[].object_info.guid`	`string`	The object GUID, in braces. The same value as `GetObjectGUID` returns.
`object_version_ex[].object_info.options`	`ITEMFLAGS`	Bit flags that provide additional information on the object (e.g. is the object deleted or a stub).
`object_version_ex[].object_info.original_vault_guid`	`string`	The GUID of the vault in which the object was originally created.
`object_version_ex[].object_info.original_vault_obj_id`	`ObjID`	The original objid in the vault in which the object was originally created.
`object_version_ex[].object_info.associated_view_id`	`ItemID`	Identifies the view associated with this object if any.
`object_version_ex[].object_info.external_repository_icon_id`	`string`	If not null, identifies the icon of the object. Currently applicable only to unmanaged objects.
`object_version_ex[].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_version_ex[].object_info.capabilities`	`OBJECTCAPABILITYFLAGS`	Bit flags that provide information on the object capabilities.
`prop_val_arrays[]`	repeated `PropertyValueArray`	The property values of each object, in request order.
`prop_val_arrays[].value[]`	repeated `PropertyValue`	Property values.
`prop_val_arrays[].value[].property_def`	`int32`	The property definition ID, for example 0 for "Name or title" or 100 for "Class".
`prop_val_arrays[].value[].value`	`TypedValue`	The value. Its `type` must match the data type of the property definition.