IRPCNamedValueStorage.GetNamedValues

View as Markdown

Vault API / standard read session idempotent returns metadata structure version

Gets all named values of one storage type and namespace.

ServiceNamed value storage MFiles.IRPCNamedValueStorage
gRPC method/MFiles.IRPCNamedValueStorage/GetNamedValues
HTTP (mf-http-grpc)POST /grpc/v1/get-named-values
RequestGetNamedValuesRequest
ResponseGetNamedValuesResponse
Book and levelVault API, standard
Kindread
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: GetNamedValuesRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
storage_typeNamedValueTypeThe storage type to read. See the table in the service overview.Values: NAMED_VALUE_TYPE_UNINITIALIZED (0), NAMED_VALUE_TYPE_PROPERTY_AUTOMATIC_NUMBERING (1), NAMED_VALUE_TYPE_VAULT_SHARED_VARIABLE (2), NAMED_VALUE_TYPE_METADATA_CONFIGURATION_VALUE (3), NAMED_VALUE_TYPE_USER_CONFIGURATION_VALUE (4), NAMED_VALUE_TYPE_REGISTRY_VALUE (5), NAMED_VALUE_TYPE_FOLDER_CONFIGURATION_VALUE (6), NAMED_VALUE_TYPE_ADMIN_CONFIGURATION_VALUE (7), NAMED_VALUE_TYPE_SYSTEM_CONFIGURATION_VALUE (8), NAMED_VALUE_TYPE_USER_SPECIFIC_VALUE (9).
namespace_namestringThe namespace, for example "MyCompany.MyApp".

Response: GetNamedValuesResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
values[]repeated NamedValueThe values of the namespace, sorted by key.
values[].keystringThe name of the value.
values[].valueTypedValueThe value as a serialized bytearray.
values[].value.is_null_valueboolTrue if the value is empty. data is then unset.
values[].value.typeDatatypeThe data type of the value.
values[].value.dataTypedValueUnionThe value, in the member that matches type. Unset for an empty value.