IRPCIndexingDataSource2.GetIndexConfigurationsForIX

Server integration API / specialized internal: not for applications read session idempotent

Gets the vault's search index configuration as JSON, without secrets, plus the vault settings that an index built from it must agree on.

The result contains only the indexes of the engines that the cloud search indexing services serve (Smart Search and Aino Search), only an allowed set of their settings, and no setting that the vault settings mark as a password.

Service	Indexing data source (version 2) `MFiles.IRPCIndexingDataSource2`
gRPC method	`/MFiles.IRPCIndexingDataSource2/GetIndexConfigurationsForIX`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-index-configurations-for-ix`
Request	`GetIndexConfigurationsForIXRequest`
Response	`GetIndexConfigurationsForIXResponse`
Book and level	Server integration API, specialized
Kind	read
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

For M-Files components only. M-Files' cloud search indexing services call it. Applications should not call it.

Requires a vault session with the vault rights see_all_objects and see_deleted_objects. Read-only.

Request: GetIndexConfigurationsForIXRequest

No fields.

Response: GetIndexConfigurationsForIXResponse

The response of GetIndexConfigurationsForIX: the vault's search index configuration without secrets, plus the vault settings that an index built from it must agree on.

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_configurations_json`	`string`	A JSON object with `Indices` (the stored index settings) and the added members `FacetSources` (the vault's facet definitions), `SearchLanguages` (the full-text search languages as ISO codes, primary first) and `VaultTimeZone` (the vault's time zone, in the fields of the Windows time zone information structure). Members that are empty or cannot be resolved are left out. Example: `{"Indices":[],"SearchLanguages":["en"],"VaultTimeZone":{"bias":-120,...}}`.