IRPCIndexingDataSource.GetEnabledIndexes
Server integration API / specialized internal: not for applications write session
Gets the names of the enabled indexes.
| Service | Indexing data source MFiles.IRPCIndexingDataSource |
|---|---|
| gRPC method | /MFiles.IRPCIndexingDataSource/GetEnabledIndexes |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-enabled-indexes |
| Request | GetEnabledIndexesRequest |
| Response | GetEnabledIndexesResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. Search indexers call it to learn which indexes of the vault are enabled. Applications should not call it.
- Requires the system administrator server role (server right
log_in_to_any_vault); a vault administrator is denied.
Request: GetEnabledIndexesRequest
No fields.
Response: GetEnabledIndexesResponse
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 |
|---|---|---|
index_names[] | repeated IndexName | Index names. |
index_names[].configuration_name | string | The name of the index configuration. |
index_names[].repository_connection | string | Identifies the external repository connection. |
index_names[].configuration_type | IndexConfigurationType | The index configuration type (e.g., Shared versus Legacy).Values: INDEX_CONFIGURATION_TYPE_UNKNOWN (0), INDEX_CONFIGURATION_TYPE_LEGACY (1), INDEX_CONFIGURATION_TYPE_SHARED (2), INDEX_CONFIGURATION_TYPE_ANY (3). |