IRPCSearch.QuerySearchAgent

View as Markdown

Vault API / core read session or assertion idempotent returns metadata structure version

Runs an Aino Search query for the M-Files clients.

ServiceSearch MFiles.IRPCSearch
gRPC method/MFiles.IRPCSearch/QuerySearchAgent
HTTP (mf-http-grpc)POST /grpc/v1/query-search-agent
RequestQuerySearchAgentRequest
ResponseQuerySearchAgentResponse
Book and levelVault API, core
Kindread
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

The request and response are text documents in a format internal to the M-Files clients. The call requires Aino Search to be enabled on the server.

Request: QuerySearchAgentRequest

QuerySearchAgentRequest method structure.

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
querystringThe query in JSON.

Response: QuerySearchAgentResponse

QuerySearchAgentResponse method structure.

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
responsestringThe response in JSON.