Discovery

POST /search/suggest

Get search suggestions by query criteria.

Request

  • Base URL
    /catalog/api (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    OAuth 2
    Implicithttps://login.microsoftonline.com/common/oauth2/authorize
    Scopesuser_impersonation

Query parameters

api-versionstring required

Version of Purview APIs

Request body

keywordsstring

The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode.

limitinteger

The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100.

filterobject

The filter for the search.

Response

OK. On successful lookup of the suggestions.

Changes

No recorded changes to this operation across all 3 revisions of this API.