IRPCObjectOperations.GetProperties
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the property values of one specific object version.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetProperties |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-properties |
| Request | GetPropertiesRequest |
| Response | GetPropertiesResponse |
| 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 (OBJ_VER_VERSION_TYPE_SPECIFIC and internal_version).
The OBJ_VER_VERSION_TYPE_LATEST marker, OBJ_VER_VERSION_TYPE_ANY and an unset version all fail
with "Not found." (0x8004000B). To read the latest properties, use
GetObjectVersionAndPropertiesOfMultipleObjects
with latest_versions true, or get the version number from
GetLatestObjectVersion first.
A caller who cannot read the object gets "Access denied." (0x800407E4).
Request: GetPropertiesRequest
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 |
|---|---|---|
callimp | CallImportance | Leave unset or use CALL_IMPORTANCE_NORMAL.Values: CALL_IMPORTANCE_DEFAULT (0), CALL_IMPORTANCE_NORMAL (1), CALL_IMPORTANCE_CAN_BE_REJECTED (2). |
obj_ver | ObjVer | The object and a specific version of it. The latest-version marker is not accepted. |
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: GetPropertiesResponse
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 |
|---|---|---|
properties[] | repeated PropertyValue | The property values of the version. |
properties[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
properties[].value | TypedValue | The value. Its type must match the data type of the property definition. |
properties[].value.is_null_value | bool | True if the value is empty. data is then unset. |
properties[].value.type | Datatype | The data type of the value. |
properties[].value.data | TypedValueUnion | The value, in the member that matches type. Unset for an empty value. |
Related methods
- GetObjectVersionAndPropertiesOfMultipleObjects -- Gets the version information and the property values of several objects in one call. The preferred way to read objects.
- GetLatestObjectVersion -- Gets the number and GUID of the latest version of an object.
- GetPropertiesOfMultipleObjects -- Gets the property values of several specific object versions.