IRPCNamedValueStorage.GetNamedValues
Vault API / standard read session idempotent returns metadata structure version
Gets all named values of one storage type and namespace.
| Service | Named value storage MFiles.IRPCNamedValueStorage |
|---|---|
| gRPC method | /MFiles.IRPCNamedValueStorage/GetNamedValues |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-named-values |
| Request | GetNamedValuesRequest |
| Response | GetNamedValuesResponse |
| 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 | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires a vault session; the read rights depend on
storage_type(see the service overview). A storage type the caller cannot read fails with "Access denied.". - Returns every value in the namespace, sorted by key. An unknown namespace returns an empty list, not an error.
- With
NAMED_VALUE_TYPE_USER_SPECIFIC_VALUEonly the calling user's own values are returned. - A namespace longer than 100 characters fails with "The parameter is incorrect. (Too long namespace.)".
Request: GetNamedValuesRequest
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 |
|---|---|---|
storage_type | NamedValueType | The 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_name | string | The 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.
| Field | Type | Description |
|---|---|---|
values[] | repeated NamedValue | The values of the namespace, sorted by key. |
values[].key | string | The name of the value. |
values[].value | TypedValue | The value as a serialized bytearray. |
values[].value.is_null_value | bool | True if the value is empty. data is then unset. |
values[].value.type | Datatype | The data type of the value. |
values[].value.data | TypedValueUnion | The value, in the member that matches type. Unset for an empty value. |