Get catalog entities filtered by query.

post

https://example.com/public/v1/catalog/entities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

propertyFilters

array

Filters for matching properties' values:
Can be SIMPLE and COMPOUND.
SIMPLE is a key-value pair.
COMPOUND is a set of key-value pairs combined with OR or AND operator

propertyFilters

searchTerms

string

Term to search by

searchOnlyByName

boolean

Defaults to false

Perform search only by entity name. By default search will be performed considering all text properties

types

array of strings

Catalog entity types to filter by

types

includeProperties

array of strings

Entity properties that will be returned in result.
By default all entity properties are included in response.
If includeProperties is passed, regardless of which properties are specified, 'id' and 'type' fields will be always included

includeProperties

pageNumber

number

Defaults to 0

pageSize

number

Defaults to 20

sort

object

Sort entities by property in ASC or DESC order

Responses

400

Returned when request body is not valid

200