Discovery

POST /search/query

Gets data using search.

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 searchable fields.

offsetinteger

The offset. The default value is 0. The maximum value is 100000.

limitinteger

The limit of the number of the search result. default value is 50; maximum value is 1000.

orderbySearchOrderItem[]

The sort order of search results, can specify multiple fields.

filterobject

The filter for the search. See examples for the usage of supported filters.

Response

OK. On successful lookup of the advanced search.

@search.countinteger

The total number of search results (not the number of documents in a single page).

Changes

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