Search (v1)

Search by Fulltext Query

Generally Available

Retrieve data for the specified fulltext query.

get/catalog/v1/search/basic

Query parameters

querystring

The full-text query

typestring[]

Limit the result to only entities of specified types

attrstring[]

One of more additional attributes to return in the response

tagstring

Limit the result to only entities tagged with the given tag

sortBystring

An attribute to sort by

sortOrder'ASCENDING' | 'DESCENDING'

Sort order, either ASCENDING (default) or DESCENDING

deletedboolean

Whether to include deleted entities

limitinteger

Limit the result set to only include the specified number of entries

offsetinteger

Start offset of the result set (useful for pagination)

Response

On successful fulltext query with some results, might return an empty list if execution succeeded without any results

typesstring[]

The types

referredEntitiesobject

The referred entities

Changes

No recorded changes to this endpoint across all 1 revision of this API.