IRPCVault.GetMetadataStructureItemIdsByAliases_Compressed
Vault API / core read session or assertion idempotent returns metadata structure version
Gets alias-to-ID mappings of several kinds of metadata structure item as JSON, with the option to exclude kinds.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/GetMetadataStructureItemIdsByAliases_Compressed |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-metadata-structure-item-ids-by-aliases_-compressed |
| Request | GetMetadataStructureItemIdsByAliases_CompressedRequest |
| Response | GetMetadataStructureItemIdsByAliases_CompressedResponse |
| 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
Works like
GetMetadataStructureItemIdsByAliases,
with the same JSON format and compression, but takes lists of kinds. unambiguous_aliases_only
must be true. Excluding METADATA_STRUCTURE_ITEM_ALL fails with E_INVALIDARG.
Request: GetMetadataStructureItemIdsByAliases_CompressedRequest
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 |
|---|---|---|
msi_array_included[] | repeated MetadataStructureItem | The kinds of item to return. A single METADATA_STRUCTURE_ITEM_ALL means every kind that can have aliases. |
msi_array_excluded | MetadataStructureItemArray | Optional. Kinds to leave out, typically together with METADATA_STRUCTURE_ITEM_ALL in msi_array_included. |
msi_array_excluded.value[] | repeated MetadataStructureItem | An array of the MetadataStructureItem values. |
unambiguous_aliases_only | bool | Must be true; false fails with E_NOTIMPL. |
Response: GetMetadataStructureItemIdsByAliases_CompressedResponse
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 |
|---|---|---|
data | bytes | NUL-terminated UTF-8 JSON, zlib-compressed unless uncompressed_length is 4294967295. |
uncompressed_length | uint32 | Size of the decompressed data, or 4294967295 if data is not compressed. |
Related methods
- GetMetadataStructureItemIdsByAliases -- Gets all unambiguous alias-to-ID mappings of one kind of metadata structure item, or of all kinds, as JSON.
- GetMetadataStructure -- Gets the vault's real object types (not value lists), with icons, in one call.