IRPCObjectOperations.GetPropertiesOfMultipleObjects
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the property values of several specific object versions.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetPropertiesOfMultipleObjects |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-properties-of-multiple-objects |
| Request | GetPropertiesOfMultipleObjectsRequest |
| Response | GetPropertiesOfMultipleObjectsResponse |
| 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
Like GetProperties for many versions: each
item of objvers must name a specific version, and the whole call fails with "Not found." if any
of them is missing. properties[i] belongs to objvers[i].
Request: GetPropertiesOfMultipleObjectsRequest
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). |
objvers[] | repeated ObjVer | Specific object versions. The latest-version marker is not accepted. |
objvers[].obj_id | ObjID | The object. |
objvers[].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). |
objvers[].obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
objvers[].version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
objvers[].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). |
objvers[].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. |
objvers[].version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
objvers[].version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
Response: GetPropertiesOfMultipleObjectsResponse
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 PropertyValueArray | The property values of each version, in the request order. |
properties[].value[] | repeated PropertyValue | Property values. |
properties[].value[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
properties[].value[].value | TypedValue | The value. Its type must match the data type of the property definition. |
Related methods
- GetProperties -- Gets the property values of one specific object version.