IRPCIndexingDataSource.GetIndexingOptions

Server integration API / specialized internal: not for applications write session

Gets the indexing options of one index, or of all indexes, as JSON.

Service	Indexing data source `MFiles.IRPCIndexingDataSource`
gRPC method	`/MFiles.IRPCIndexingDataSource/GetIndexingOptions`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-indexing-options`
Request	`GetIndexingOptionsRequest`
Response	`GetIndexingOptionsResponse`
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. Applications should not call it.

Requires the system administrator server role (server right log_in_to_any_vault).

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_name`	`IndexName`	The target indexer. If empty, indexing options for all indexes are returned.
`index_name.configuration_name`	`string`	The name of the index configuration.
`index_name.repository_connection`	`string`	Identifies the external repository connection.
`index_name.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).

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
`indexing_options_json`	`string`	Receives the indexing options object. Empty if the index is currently disabled.