IRPCVaultAdmin.ExecuteIndexManagementOperation

Administration API / specialized admin session

Runs a management operation on one search index of the vault: rebuild, re-index, activate, enable, disable or delete.

Service	Vault administration `MFiles.IRPCVaultAdmin`
gRPC method	`/MFiles.IRPCVaultAdmin/ExecuteIndexManagementOperation`
HTTP (mf-http-grpc)	`POST /grpc/v1/execute-index-management-operation`
Request	`ExecuteIndexManagementOperationRequest`
Response	`ExecuteIndexManagementOperationResponse`
Book and level	Administration API, specialized
Kind	admin
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

Requires a vault session and the vault right verify_vault. Activate, enable, disable and delete also require the system administrator server role (server right manage_vaults).
Rebuild and re-index start background work by the M-Files indexing service; there is no task ID to follow. Re-index works only on combined indexes (INDEXED_DATA_TYPE_COMBINED).
Get the index names and the operations allowed for the caller from GetIndexOptions.

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
`operation_data`	`IndexManagementOperationData`	The index (`name`, as returned by GetIndexOptions) and the operation.
`operation_data.name`	`IndexName`	The name of the index.
`operation_data.name.configuration_name`	`string`	The name of the index configuration.
`operation_data.name.repository_connection`	`string`	Identifies the external repository connection.
`operation_data.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).
`operation_data.operation`	`IndexManagementOperation`	Operation to be executed.Values: `INDEX_MANAGEMENT_OPERATION_UNKNOWN` (0), `INDEX_MANAGEMENT_OPERATION_REBUILD` (1), `INDEX_MANAGEMENT_OPERATION_REINDEX` (2), `INDEX_MANAGEMENT_OPERATION_ACTIVATE` (3), `INDEX_MANAGEMENT_OPERATION_ENABLE` (4), `INDEX_MANAGEMENT_OPERATION_DISABLE` (5), `INDEX_MANAGEMENT_OPERATION_DELETE` (6).

No fields.

GetIndexOptions -- Lists the search indexes of the vault with their state and the management operations the caller may run on each.